Rename Project Agent

Rename an agent — updates agent_id on all policy scopes for (org, project, agent). The "default" agent cannot be renamed.

Bearer token or X-API-Keyscope: adminoperation_id: projects.renameAgent

Authentication

Send either Authorization: Bearer <token> or X-API-Key: <token>. The caller must hold the "admin" role on the organization. Any org token with sufficient scope. Create tokens from the console or the /v1/orgs/{org_id}/tokens endpoints. Requests without a valid credential are rejected with 401.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X PATCH "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/projects/00000000-0000-0000-0000-000000000000/agents/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer $ZNYX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "new_agent_id": "string"
}'

Response

application/json

Successful Response

null

Schema: any

Path parameters

Name	Type	Required	Description
org_id#path	string	required	-
project_id#path	string	required	-
agent_id#path	string	required	-

Header parameters

Name	Type	Required	Description
x-created-by#header	string \| null	optional	-
X-API-Key#header	string \| null	optional	-
authorization#header	string \| null	optional	-

Request bodyrequired

Field	Type	Required	Description
new_agent_id	string	required	New agent identifier

Responses

Status	Description
200	Successful Response
422	Validation Error

Response schema

any

Errors & what triggers them

Code	Trigger	Fix
401	Missing or expired Authorization header.	-
403	Token does not have the required role (admin / editor).	-
404	Target resource does not exist in this org.	-
422	Request body failed validation.	-