Status - Get

Service:

Build

API Version:

6.0-preview.1

Gets the build status for a definition, optionally scoped to a specific branch, stage, job, and configuration.

If there are more than one, then it is required to pass in a stageName value when specifying a jobName, and the same rule then applies for both if passing a configuration parameter.

GET https://dev.azure.com/{organization}/{project}/_apis/build/status/{definition}?api-version=6.0-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/build/status/{definition}?branchName={branchName}&stageName={stageName}&jobName={jobName}&configuration={configuration}&label={label}&api-version=6.0-preview.1

URI Parameters

Name	In	Required	Type	Description
definition	path	True	string	Either the definition name with optional leading folder path, or the definition id.
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '6.0-preview.1' to use this version of the api.
branchName	query		string	Only consider the most recent build for this branch.
configuration	query		string	Use this job configuration to render the status
jobName	query		string	Use this job within a stage of the pipeline to render the status.
label	query		string	Replaces the default text on the left side of the badge.
stageName	query		string	Use this stage within the pipeline to render the status.

Responses

Name	Type	Description
200 OK	string	successful operation