DeploymentInstance

Represents an instance that has been deployed to external system, along with deployment history.

Properties

id

The unique identifier of this deployment instance.

currentState

The current deployment state of this instance. Possible values:

IN_PROGRESS — the deployment is currently running.
SUCCESSFUL — the deployment completed successfully.
FAILED — the deployment failed.
CANCELLED — the deployment was canceled.
UNKNOWN — the deployment state could not be determined.

attributes

Arbitrary key-value attributes associated with this deployment instance (for example, environment-specific metadata).

deploymentStateEntries

The history of deployment state changes for this instance.

deploymentDashboard

The deployment dashboard that tracks this instance.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<deploymentInstance attributes="Map{}" currentState="SUCCESSFUL" id="my-instance-id">
  <deploymentStateEntries count="3">
    <historyFromPosted>[[[DeploymentHistory...|deploymenthistory.html]]]</historyFromPosted>
    <deploymentStateEntry>[[[deploymentStateEntry...|deploymentstateentry.html]]]</deploymentStateEntry>
  </deploymentStateEntries>
  <deploymentDashboard id="my-dashboard-id" name="Production Deployment">
    <deploymentInstances>[[[deploymentInstances...|deploymentinstances.html]]]</deploymentInstances>
    <project>[[[project...|project.html]]]</project>
  </deploymentDashboard>
</deploymentInstance>

{
  "deploymentDashboard" : "[[[deploymentDashboard...|deploymentdashboard.html]]]",
  "attributes" : {
    "key" : "attributes"
  },
  "id" : "my-instance-id",
  "currentState" : "SUCCESSFUL",
  "deploymentStateEntries" : "[[[deploymentStateEntries...|deploymentstateentries.html]]]"
}

Last modified: 18 August 2026