TeamCity REST API Reference 2026.2 Help

DeploymentStateEntry

Represents a state of deployment instance.

Properties

state

The deployment state at the time of this entry. 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.

deploymentDate

The timestamp when this deployment state was recorded.

entryFromPosted

build

The build that produced this deployment state, if applicable.

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.

<deploymentStateEntry deploymentDate="20250520T183916+0200" state="SUCCESSFUL"> <entryFromPosted buildId="123456789" changeDate="2000-01-23T04:56:07.000Z" state="string"/> <build artifactsDirectory="/Users/John.Doe/.BuildServer/system/artifacts/ProjectName/ConfigName/1337" branchName="sandbox" buildTypeId="ProjectName_BuildConfName" buildTypeInternalId="string" chainModificationId="1916" changesCollectingInProgress="false" composite="false" currentSettingsHash="a3f5c2e1d8b74906" customized="true" defaultBranch="true" detachedFromAgent="false" failedToStart="true" finishDate="20240408T162702+0200" finishEstimate="20240409T160130+0200" finishOnAgentDate="20240408T162702+0200" history="true" href="/app/rest/builds/id:8006" id="8134" limitedChangesCount="3" locator="id:22011" modificationId="1916" number="54" parallelized="true" percentageComplete="123" personal="true" pinned="true" queuePosition="2" queuedDate="20240408T162059+0200" running="true" settingsHash="a3f5c2e1d8b74906" startDate="20240408T162559+0200" startEstimate="20240409T155123+0200" state="queued" status="SUCCESS" statusText="Tests passed: 5, muted: 1" taskId="22011" unspecifiedBranch="false" usedByOtherBuilds="true" waitReason="There are no idle compatible agents which can run this build" webUrl="https://example.com/app/rest/builds/id:8006"> <links>[[[links...|links.html]]]</links> <buildType>[[[buildType...|buildtype.html]]]</buildType> <comment>[[[comment...|comment.html]]]</comment> <tags>[[[tags...|tags.html]]]</tags> <pinInfo>[[[comment...|comment.html]]]</pinInfo> <user>[[[user...|user.html]]]</user> <delayedByBuild>[[[build...|build.html]]]</delayedByBuild> <plannedAgent>[[[agent...|agent.html]]]</plannedAgent> <approvalInfo>[[[approvalInfo...|approvalinfo.html]]]</approvalInfo> <running-info>[[[progress-info...|progressinfo.html]]]</running-info> <canceledInfo>[[[comment...|comment.html]]]</canceledInfo> <triggered>[[[TriggeredBy...|triggeredby.html]]]</triggered> <lastChanges>[[[changes...|changes.html]]]</lastChanges> <changes>[[[changes...|changes.html]]]</changes> <revisions>[[[Revisions...|revisions.html]]]</revisions> <versionedSettingsRevision>[[[Revision...|revision.html]]]</versionedSettingsRevision> <artifactDependencyChanges>[[[buildChanges...|buildchanges.html]]]</artifactDependencyChanges> <agent>[[[agent...|agent.html]]]</agent> <compatibleAgents>[[[agents...|agents.html]]]</compatibleAgents> <compatibleCloudImages>[[[cloudImages...|cloudimages.html]]]</compatibleCloudImages> <testOccurrences>[[[testOccurrences...|testoccurrences.html]]]</testOccurrences> <problemOccurrences>[[[problemOccurrences...|problemoccurrences.html]]]</problemOccurrences> <artifacts>[[[files...|files.html]]]</artifacts> <relatedIssues>[[[issuesUsages...|issuesusages.html]]]</relatedIssues> <properties>[[[properties...|properties.html]]]</properties> <resultingProperties>[[[properties...|properties.html]]]</resultingProperties> <originalProperties>[[[properties...|properties.html]]]</originalProperties> <startProperties>[[[properties...|properties.html]]]</startProperties> <attributes>[[[entries...|entries.html]]]</attributes> <statistics>[[[properties...|properties.html]]]</statistics> <metadata>[[[datas...|datas.html]]]</metadata> <snapshot-dependencies>[[[builds...|builds.html]]]</snapshot-dependencies> <artifact-dependencies>[[[builds...|builds.html]]]</artifact-dependencies> <custom-artifact-dependencies>[[[artifact-dependencies...|artifactdependencies.html]]]</custom-artifact-dependencies> <replacementIds>[[[items...|items.html]]]</replacementIds> <related>[[[related...|related.html]]]</related> <triggeringOptions>[[[buildTriggeringOptions...|buildtriggeringoptions.html]]]</triggeringOptions> <statusChangeComment>[[[comment...|comment.html]]]</statusChangeComment> <vcsLabels>[[[vcsLabel...|vcslabel.html]]]</vcsLabels> <customization>[[[customizations...|customizations.html]]]</customization> <queuedWaitReasons>[[[properties...|properties.html]]]</queuedWaitReasons> <downloadedArtifacts>[[[downloadedArtifacts...|downloadedartifacts.html]]]</downloadedArtifacts> <matrixConfiguration>[[[MatrixConfiguration...|matrixconfiguration.html]]]</matrixConfiguration> <firstBuildWithSameChanges>[[[build...|build.html]]]</firstBuildWithSameChanges> <executor>[[[BuildExecutor...|buildexecutor.html]]]</executor> <anchorBuild>[[[build...|build.html]]]</anchorBuild> </build> </deploymentStateEntry>
{ "deploymentDate" : "20250520T183916+0200", "entryFromPosted" : { "changeDate" : "2000-01-23T04:56:07.000+00:00", "buildId" : 7, "state" : "IN_PROGRESS" }, "build" : { "agent" : "[[[agent...|agent.html]]]", "metadata" : "[[[datas...|datas.html]]]", "triggered" : "[[[TriggeredBy...|triggeredby.html]]]", "usedByOtherBuilds" : true, "settingsHash" : "a3f5c2e1d8b74906", "parallelized" : true, "number" : "54", "chainModificationId" : "1916", "changesCollectingInProgress" : false, "lastChanges" : "[[[changes...|changes.html]]]", "resultingProperties" : "[[[properties...|properties.html]]]", "composite" : false, "executor" : "[[[BuildExecutor...|buildexecutor.html]]]", "links" : "[[[links...|links.html]]]", "id" : 8134, "state" : "queued", "href" : "/app/rest/builds/id:8006", "detachedFromAgent" : false, "compatibleCloudImages" : "[[[cloudImages...|cloudimages.html]]]", "artifacts" : "[[[files...|files.html]]]", "testOccurrences" : "[[[testOccurrences...|testoccurrences.html]]]", "artifactDependencyChanges" : "[[[buildChanges...|buildchanges.html]]]", "startProperties" : "[[[properties...|properties.html]]]", "defaultBranch" : true, "compatibleAgents" : "[[[agents...|agents.html]]]", "artifact-dependencies" : "[[[builds...|builds.html]]]", "replacementIds" : "[[[items...|items.html]]]", "personal" : true, "history" : true, "tags" : "[[[tags...|tags.html]]]", "canceledInfo" : "[[[comment...|comment.html]]]", "matrixConfiguration" : "[[[MatrixConfiguration...|matrixconfiguration.html]]]", "running-info" : "[[[progress-info...|progressinfo.html]]]", "versionedSettingsRevision" : "[[[Revision...|revision.html]]]", "percentageComplete" : 6, "webUrl" : "https://example.com/app/rest/builds/id:8006", "buildType" : "[[[buildType...|buildtype.html]]]", "triggeringOptions" : "[[[buildTriggeringOptions...|buildtriggeringoptions.html]]]", "locator" : "id:22011", "startDate" : "20240408T162559+0200", "status" : "SUCCESS", "pinned" : true, "customized" : true, "approvalInfo" : "[[[approvalInfo...|approvalinfo.html]]]", "vcsLabels" : [ "[[[vcsLabel...|vcslabel.html]]]" ], "customization" : "[[[customizations...|customizations.html]]]", "finishEstimate" : "20240409T160130+0200", "changes" : "[[[changes...|changes.html]]]", "plannedAgent" : "[[[agent...|agent.html]]]", "running" : true, "statusChangeComment" : "[[[comment...|comment.html]]]", "finishOnAgentDate" : "20240408T162702+0200", "buildTypeId" : "ProjectName_BuildConfName", "buildTypeInternalId" : "buildTypeInternalId", "originalProperties" : "[[[properties...|properties.html]]]", "modificationId" : "1916", "related" : "[[[related...|related.html]]]", "failedToStart" : true, "revisions" : "[[[Revisions...|revisions.html]]]", "delayedByBuild" : "[[[build...|build.html]]]", "queuePosition" : 2, "problemOccurrences" : "[[[problemOccurrences...|problemoccurrences.html]]]", "anchorBuild" : "[[[build...|build.html]]]", "artifactsDirectory" : "/Users/John.Doe/.BuildServer/system/artifacts/ProjectName/ConfigName/1337", "relatedIssues" : "[[[issuesUsages...|issuesusages.html]]]", "branchName" : "sandbox", "startEstimate" : "20240409T155123+0200", "downloadedArtifacts" : "[[[downloadedArtifacts...|downloadedartifacts.html]]]", "limitedChangesCount" : 3, "firstBuildWithSameChanges" : "[[[build...|build.html]]]", "currentSettingsHash" : "a3f5c2e1d8b74906", "unspecifiedBranch" : false, "queuedWaitReasons" : "[[[properties...|properties.html]]]", "waitReason" : "There are no idle compatible agents which can run this build", "pinInfo" : "[[[comment...|comment.html]]]", "snapshot-dependencies" : "[[[builds...|builds.html]]]", "statusText" : "Tests passed: 5, muted: 1", "custom-artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]", "comment" : "[[[comment...|comment.html]]]", "finishDate" : "20240408T162702+0200", "attributes" : "[[[entries...|entries.html]]]", "user" : "[[[user...|user.html]]]", "queuedDate" : "20240408T162059+0200", "taskId" : 22011, "properties" : "[[[properties...|properties.html]]]", "statistics" : "[[[properties...|properties.html]]]" }, "state" : "SUCCESSFUL" }
Last modified: 18 August 2026