DeploymentResponse
objectA deployment of an agent version to a specific environment, plus
who created it and when.
idstringrequired
Unique deployment identifier
accountIdstringrequired
Account this deployment belongs to
agentIdstringrequired
Agent (project) this deployment belongs to
environmentstringrequired
Environment (sandbox, pre-release, live)
artifactVersionstringrequired
Artifact version reference
versionstringrequired
Version hash linking deployments across environments
createdBystringrequired
Email of user who created the deployment
createdAtstringrequired
ISO 8601 timestamp of when the deployment was created
metadataobject
Deployment metadata (e.g. deployment_message)
Example
DuplicateAgentBody
object * Additional properties are NOT allowed.
newAgentIdstring
Match pattern:^[a-zA-Z0-9-]+$
newAgentNamestringrequired
>= 1 characters<= 100 characters
Example
GetAgentsResponse
arrayaccountIdstringrequired
agentIdstringrequired
agentNamestringrequired
createdAtstringrequired
updatedAtstringrequired
branchCountnumberrequired
GetAttributesResponse
object * Additional properties are NOT allowed.
attributesarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example
GetConfigPageResponse
objectA single config page for one environment.
clientEnvstringrequired
Environment (sandbox, pre-release, live)
variablesobject
Config key-value pairs
schemaobject
JSON Schema (Draft 7) definition
lastUpdatedstring
ISO 8601 timestamp of last update
Example