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

Read one Environment Agent

Return an Environment Agent and its current append-only release state.

Authentication

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

Parameters

NameLocationRequiredDescription
organizationIdpathYes
The Organization to address.
string
All of
  • maximum length 64
A Cantora Organization identifier, prefixed with `org_`.
  • pattern ^org_[\s\S]+$
projectIdpathYes
The Project to address.
string
All of
  • maximum length 64
A Cantora Project identifier, prefixed with `proj_`.
  • pattern ^proj_[\s\S]+$
environmentIdpathYes
The Environment to address.
string
All of
  • maximum length 64
A Cantora Environment identifier, prefixed with `env_`.
  • pattern ^env_[\s\S]+$
principalIdpathYes
The Principal to address.
string
All of
  • maximum length 64
A Cantora Principal identifier, prefixed with `principal_`.
  • pattern ^principal_[\s\S]+$

Responses

200Agent
application/json
AgentJsonEncoding
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedJsonEncoding
403Forbidden
application/json
ForbiddenJsonEncoding
404NotFound
application/json
NotFoundJsonEncoding

Reusable schemas

AgentJsonEncoding

object
  • unknown properties allowed false
principalIdrequired
stringThe Principal identifier.
All of
  • maximum length 64
A Cantora Principal identifier, prefixed with `principal_`.
  • pattern ^principal_[\s\S]+$
statusrequired
stringThe current lifecycle status.
  • allowed values "active", "disabled"
organizationIdrequired
stringThe Organization identifier.
All of
  • maximum length 64
A Cantora Organization identifier, prefixed with `org_`.
  • pattern ^org_[\s\S]+$
projectIdrequired
stringThe Project identifier.
All of
  • maximum length 64
A Cantora Project identifier, prefixed with `proj_`.
  • pattern ^proj_[\s\S]+$
environmentIdrequired
stringThe Environment identifier.
All of
  • maximum length 64
A Cantora Environment identifier, prefixed with `env_`.
  • pattern ^env_[\s\S]+$
agentDefinitionIdrequired
stringThe Agent Definition identifier.
All of
  • maximum length 64
A Cantora Agent Definition identifier, prefixed with `agentdef_`.
  • 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
string
All of
  • maximum length 64
A Cantora Agent Release identifier, prefixed with `agent_release_`.
  • pattern ^agent_release_[\s\S]+$
null
releaseGenerationrequired
integerThe current Agent Release generation, starting at zero before activation.
All of
  • minimum 0
releaseEtagrequired
stringThe strong ETag for the Agent's current release generation.
All of
  • maximum length 12
The current strong Agent Release ETag, including its double quotes.
  • pattern ^"(?:0|[1-9][0-9]{0,9})"$
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time

UnauthorizedJsonEncoding

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.

ForbiddenJsonEncoding

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

NotFoundJsonEncoding

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "NotFound"
resourcerequired
stringThe resource type relevant to the error.
idrequired
stringThe identifier supplied for the resource that was not found.