Skip to content
CantoraAPI documentation
GET
/v1/organizations/{organizationId}/projects/{projectId}/environments/{environmentId}/agents

List Agents in an Environment

Return a bounded page of Environment Agents in stable creation order, continuing from an opaque cursor when supplied.

Authentication

Send an API key as a Bearer token in the Authorization header.

Parameters

NameLocationRequiredDescription
organizationIdpathYes
The Organization to address.
stringA Cantora Organization identifier, prefixed with `org_`.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdpathYes
The Project to address.
stringA Cantora Project identifier, prefixed with `proj_`.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdpathYes
The Environment to address.
stringA Cantora Environment identifier, prefixed with `env_`.
  • maximum length 64
  • pattern ^env_[\s\S]+$
cursorqueryNo
The opaque continuation token returned by the preceding page.
string
  • maximum length 2048
  • minimum length 1
  • pattern ^[A-Za-z0-9_-]+$
limitqueryNo
The maximum number of resources to return, from 1 through 100.
string
  • pattern ^[+-]?\d*\.?\d+(?:[Ee][+-]?\d+)?$

Responses

200AgentPage
application/json
AgentPageEncoded
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedEncoded
403Forbidden
application/json
ForbiddenEncoded

Reusable schemas

AgentPageEncoded

object
  • unknown properties allowed false
itemsrequired
arrayThe resources in this page, in stable order.
Items
AgentEncoded
nextCursorrequired
The opaque continuation token for the next page, or null after the final page.
Any of
string
  • maximum length 2048
  • minimum length 1
  • pattern ^[A-Za-z0-9_-]+$
null

UnauthorizedEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Unauthorized"
reasonrequired
stringA safe explanation of why the credential was rejected.

ForbiddenEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Forbidden"
permissionrequired
stringThe permission required by the refused operation.

AgentEncoded

object
  • unknown properties allowed false
principalIdrequired
stringThe Principal identifier.
  • maximum length 64
  • pattern ^principal_[\s\S]+$
statusrequired
PrincipalStatusThe current lifecycle status.
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdrequired
stringThe Project identifier.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdrequired
stringThe Environment identifier.
  • maximum length 64
  • pattern ^env_[\s\S]+$
agentDefinitionIdrequired
stringThe Agent Definition identifier.
  • maximum length 64
  • pattern ^agentdef_[\s\S]+$
definitionKeyrequired
stringThe stable Agent Definition key.
displayNamerequired
stringThe human-readable resource name.
currentAgentReleaseIdrequired
The current Agent Release identifier, or null before the first activation.
Any of
stringA Cantora Agent Release identifier, prefixed with `agent_release_`.
  • maximum length 64
  • pattern ^agent_release_[\s\S]+$
null
releaseGenerationrequired
integerThe current Agent Release generation, starting at zero before activation.
  • minimum 0
releaseEtagrequired
stringThe strong ETag for the Agent's current release generation.
  • maximum length 12
  • pattern ^"(?:0|[1-9][0-9]{0,9})"$
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time

PrincipalStatus

string
  • allowed values "active", "disabled"