Share via


Badge - Get

This endpoint is deprecated. Please see the Build Status REST endpoint.

GET https://dev.azure.com/{organization}/_apis/public/build/definitions/{project}/{definitionId}/badge?api-version=7.1
GET https://dev.azure.com/{organization}/_apis/public/build/definitions/{project}/{definitionId}/badge?branchName={branchName}&api-version=7.1

URI Parameters

Name In Required Type Description
definitionId
path True

integer (int32)

The ID of the definition.

organization
path True

string

The name of the Azure DevOps organization.

project
path True

string (uuid)

The project ID or name.

api-version
query True

string

Version of the API to use. This should be set to '7.1' to use this version of the api.

branchName
query

string

The name of the branch.

Responses

Name Type Description
200 OK

string

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.build Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to receive notifications about build events via service hooks.