TeamCity REST API Reference 2026.1 Help

DeploymentInstance

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

Properties

id

currentState

attributes

deploymentStateEntries

deploymentDashboard

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="string" id="string"> <deploymentStateEntries count="123"> <historyFromPosted>[[[DeploymentHistory...|deploymenthistory.html]]]</historyFromPosted> <deploymentStateEntry>[[[deploymentStateEntry...|deploymentstateentry.html]]]</deploymentStateEntry> </deploymentStateEntries> <deploymentDashboard id="string" name="string"> <deploymentInstances>[[[deploymentInstances...|deploymentinstances.html]]]</deploymentInstances> <project>[[[project...|project.html]]]</project> </deploymentDashboard> </deploymentInstance>
{ "deploymentDashboard" : "[[[deploymentDashboard...|deploymentdashboard.html]]]", "attributes" : { "key" : "attributes" }, "id" : "id", "currentState" : "IN_PROGRESS", "deploymentStateEntries" : "[[[deploymentStateEntries...|deploymentstateentries.html]]]" }
Last modified: 04 April 2026