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

Responses

200ConfigurationRevision
application/json
ConfigurationRevisionJsonEncoding
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

ConfigurationRevisionJsonEncoding

object
  • unknown properties allowed false
configurationRevisionIdrequired
stringThe durable Configuration Revision identifier.
All of
  • maximum length 64
A Cantora Configuration Revision identifier, prefixed with `configuration_revision_`.
  • pattern ^configuration_revision_[\s\S]+$
requestIdrequired
stringThe request identifier used for logs and support.
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]+$
testEnvironmentIdrequired
stringThe Test Environment identifier, or null before it can be resolved.
All of
  • maximum length 64
A Cantora Environment identifier, prefixed with `env_`.
  • pattern ^env_[\s\S]+$
agentDefinitionIdrequired
The Agent Definition identifier.
Any of
string
All of
  • maximum length 64
A Cantora Agent Definition identifier, prefixed with `agentdef_`.
  • pattern ^agentdef_[\s\S]+$
null
testAgentPrincipalIdrequired
The Test Agent Principal identifier, or null before it is created.
Any of
string
All of
  • maximum length 64
A Cantora Principal identifier, prefixed with `principal_`.
  • pattern ^principal_[\s\S]+$
null
agentVersionIdrequired
The immutable Agent Version identifier.
Any of
string
All of
  • maximum length 64
A Cantora Agent Version identifier, prefixed with `agent_version_`.
  • pattern ^agent_version_[\s\S]+$
null
testAgentReleaseIdrequired
The Test Agent Release identifier, or null before it is activated.
Any of
string
All of
  • maximum length 64
A Cantora Agent Release identifier, prefixed with `agent_release_`.
  • 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.
sourcerequired
AgentConfigurationSourceThe source revision and automation provenance.
failurerequired
The safe failure detail, or null unless the Configuration Revision failed.
Any of
ConfigurationRevisionFailureJsonEncoding
null
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time
updatedAtrequired
stringWhen the resource was last updated, 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.

ConfigurationRevisionProgress

object
  • unknown properties allowed false
agentDefinitionrequired
stringWhether the Agent Definition step has completed.
  • allowed values "Pending", "Succeeded"
testAgentrequired
stringWhether the Test Agent step has completed.
  • allowed values "Pending", "Succeeded"
agentVersionrequired
stringWhether the Agent Version step has completed.
  • allowed values "Pending", "Succeeded"
testReleaserequired
stringThe desired Test Environment and activation reason.
  • allowed values "Pending", "Succeeded"

AgentConfigurationSource

object
  • unknown properties allowed false
repositoryrequired
stringThe source repository identifier.
All of
  • minimum length 1
  • maximum length 500
commitrequired
stringThe immutable source revision.
All of
  • minimum length 1
  • maximum length 500
pathrequired
stringThe path within the source repository.
All of
  • minimum length 1
  • maximum length 500
workflowrequired
stringThe source automation workflow identifier.
All of
  • minimum length 1
  • maximum length 500
runrequired
stringThe source automation run identifier.
All of
  • minimum length 1
  • maximum length 500
actorrequired
stringThe source-control or automation actor that requested the change.
All of
  • minimum length 1
  • maximum length 500

ConfigurationRevisionFailureJsonEncoding

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