Skip to main content

Projects & Environments

GET/v1/orgs/{org_id}/projects/{project_id}/agents

List Project Agents

List distinct agents (policy scopes) for a project. Maps org_id → tenant_id, project_id → app_id in PolicyScope.

Bearer token or X-API-Keyscope: org memberoperation_id: projects.listAgents

Authentication

Send either Authorization: Bearer <token> or X-API-Key: <token>. 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 GET "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/projects/00000000-0000-0000-0000-000000000000/agents" \
  -H "Authorization: Bearer $ZNYX_TOKEN"

Response

application/json

Successful Response

[
  {
    "agent_id": "string",
    "environments": [
      null
    ]
  }
]

Schema: AgentScopeResponse[]

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired-
project_id#pathstringrequired-

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional-
authorization#headerstring | nulloptional-

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

agent_idrequiredstring
environmentsrequiredany[]

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.-
403Token does not have org access (wrong org_id, or insufficient role).-
404Resource does not exist in this org.-