TeamCity REST API Reference 2022.10 Help

BuildQueueApi

deleteAllQueuedBuilds

Delete all queued builds.

Endpoint

/app/rest/buildQueue

Parameters

getAllQueuedBuilds

Get all queued builds.

Endpoint

/app/rest/buildQueue

Produces

  • application/xml

  • application/json

Parameters

Response

Builds

addBuildToQueue

Add a new build to the queue.

Endpoint

/app/rest/buildQueue

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

  • body: Build

  • moveToTop: boolean

Response

Build

setQueuedBuildsOrder

Update the build queue order.

Endpoint

/app/rest/buildQueue/order

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Builds

getQueuedBuildPosition

Get the queue position of a queued matching build.

Endpoint

/app/rest/buildQueue/order/{queuePosition}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

  • queuePosition: string

  • fields: string

Response

Build

setQueuedBuildPosition

Update the queue position of a queued matching build.

Endpoint

/app/rest/buildQueue/order/{queuePosition}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

  • queuePosition: string

  • body: Build

  • fields: string

Response

Build

getApprovalInfo

Get approval info of a queued matching build.

Endpoint

/app/rest/buildQueue/{buildLocator}/approvalInfo

Produces

  • application/xml

  • application/json

Parameters

Response

ApprovalInfo

approveQueuedBuild

Approve queued build with approval feature enabled.

Endpoint

/app/rest/buildQueue/{buildLocator}/approve

Produces

  • application/xml

  • application/json

Parameters

Response

ApprovalInfo

getQueuedBuildTags

Get tags of the queued matching build.

Endpoint

/app/rest/buildQueue/{buildLocator}/tags

Produces

  • application/xml

  • application/json

Parameters

Response

Tags

addTagsToBuildOfBuildQueue

Add tags to the matching build.

Endpoint

/app/rest/buildQueue/{buildLocator}/tags

Consumes

  • application/xml

  • application/json

Parameters

deleteQueuedBuild

Delete a queued matching build.

Endpoint

/app/rest/buildQueue/{queuedBuildLocator}

Parameters

getQueuedBuild

Get a queued matching build.

Endpoint

/app/rest/buildQueue/{queuedBuildLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

Build

cancelQueuedBuild

Cancel a queued matching build.

Endpoint

/app/rest/buildQueue/{queuedBuildLocator}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Build

getCompatibleAgentsForBuild

Get compatible agents for a queued matching build.

Endpoint

/app/rest/buildQueue/{queuedBuildLocator}/compatibleAgents

Produces

  • application/xml

  • application/json

Parameters

Response

Agents

Last modified: 26 October 2022