Share via

Build queues

  • Article

TFS 2017 | TFS 2015 | TFS 2013

Note

Looking for REST APIS that support TFS 2018 or later versions? See the Azure DevOps REST API Reference.

api-version = 1.0

A build queue performs lightweight tasks and distributes the processor-intensive work of your build process to its pool of build agents.

If you haven't already, look at the information on getting started with these APIs.

Get a list of queues

GET https://{instance}/DefaultCollection/_apis/build/queues?api-version={version}
Parameter Type Notes
URL
instance string TFS server name ({server:port}).
Query
api-version string Version of the API to use.

Sample request

GET https://mytfsserver/DefaultCollection/_apis/build/queues?api-version=1.0

Sample response

{
  "value": [
    {
      "uri": "vstfs:///Build/Controller/274",
      "status": "offline",
      "enabled": true,
      "createdDate": "2014-01-24T06:21:00.71Z",
      "updatedDate": "2014-10-07T22:24:53.477Z",
      "queueType": "buildController",
      "id": 274,
      "name": "Hosted Build Controller",
      "url": "https://mytfsserver/DefaultCollection/_apis/build/Queues/274"
    }
  ],
  "count": 1
}

Get a queue

GET https://{instance}/DefaultCollection/_apis/build/queues/{queueId}?api-version={version}
Parameter Type Notes
URL
instance string TFS server name ({server:port}).
queueId int ID of the queue
Query
api-version string Version of the API to use.

Sample request

GET https://mytfsserver/DefaultCollection/_apis/build/queues/274?api-version=1.0

Sample response

{
  "uri": "vstfs:///Build/Controller/274",
  "status": "offline",
  "enabled": true,
  "createdDate": "2014-01-24T06:21:00.71Z",
  "updatedDate": "2014-10-07T22:24:53.477Z",
  "queueType": "buildController",
  "id": 274,
  "name": "Hosted Build Controller",
  "url": "https://mytfsserver/DefaultCollection/_apis/build/Queues/274"
}