Skip to content
CantoraAPI documentation
GET
/v1/organizations/{organizationId}/projects/{projectId}/configuration-revisions/{configurationRevisionId}

Read durable progress for one Agent Configuration apply

Return the durable progress, identifiers, and outcome for one idempotent Agent Configuration apply.

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]+$
configurationRevisionIdpathYes
The Configuration Revision to address.
stringA Cantora Configuration Revision identifier, prefixed with `configuration_revision_`.
  • maximum length 64
  • pattern ^configuration_revision_[\s\S]+$

Responses

200ConfigurationRevision
application/json
ConfigurationRevisionEncoded
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedEncoded
403Forbidden
application/json
ForbiddenEncoded
404NotFound
application/json
NotFoundEncoded

Reusable schemas

ConfigurationRevisionEncoded

object
  • unknown properties allowed false
configurationRevisionIdrequired
stringThe durable Configuration Revision identifier.
  • maximum length 64
  • pattern ^configuration_revision_[\s\S]+$
requestIdrequired
stringThe request identifier used for logs and support.
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdrequired
stringThe Project identifier.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
testEnvironmentIdrequired
stringThe Test Environment identifier, or null before it can be resolved.
  • maximum length 64
  • pattern ^env_[\s\S]+$
agentDefinitionIdrequired
The Agent Definition identifier.
Any of
stringA Cantora Agent Definition identifier, prefixed with `agentdef_`.
  • maximum length 64
  • pattern ^agentdef_[\s\S]+$
null
testAgentPrincipalIdrequired
The Test Agent Principal identifier, or null before it is created.
Any of
stringA Cantora Principal identifier, prefixed with `principal_`.
  • maximum length 64
  • pattern ^principal_[\s\S]+$
null
agentVersionIdrequired
The immutable Agent Version identifier.
Any of
stringA Cantora Agent Version identifier, prefixed with `agent_version_`.
  • maximum length 64
  • pattern ^agent_version_[\s\S]+$
null
testAgentReleaseIdrequired
The Test Agent Release identifier, or null before it is activated.
Any of
stringA Cantora Agent Release identifier, prefixed with `agent_release_`.
  • maximum length 64
  • pattern ^agent_release_[\s\S]+$
null
manifestDigestrequired
stringThe lowercase SHA-256 digest of the normalized manifest.
statusrequired
stringThe current lifecycle status.
  • allowed values "Pending", "Running", "Succeeded", "Failed"
progressrequired
ConfigurationRevisionProgressHow the Surface presents progress while work runs.
failurerequired
The safe failure detail, or null unless the Configuration Revision failed.
Any of
ConfigurationRevisionFailureEncoded
null
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time
updatedAtrequired
stringWhen the resource was last updated, in UTC.
  • format date-time

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.

NotFoundEncoded

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.

ConfigurationRevisionProgress

object
  • unknown properties allowed false
agentDefinitionrequired
ConfigurationRevisionStepStatusWhether the Agent Definition step has completed.
testAgentrequired
ConfigurationRevisionStepStatusWhether the Test Agent step has completed.
agentVersionrequired
ConfigurationRevisionStepStatusWhether the Agent Version step has completed.
testReleaserequired
ConfigurationRevisionStepStatusThe desired Test Environment and activation reason.

ConfigurationRevisionFailureEncoded

object
  • unknown properties allowed false
coderequired
stringThe stable machine-readable condition code.
messagerequired
stringThe safe human-readable condition detail.

ConfigurationRevisionStepStatus

string
  • allowed values "Pending", "Succeeded"