Badge - Get Build Badge Data

Gets a badge that indicates the status of the most recent build for the specified branch.

GET https://dev.azure.com/{organization}/{project}/_apis/build/repos/{repoType}/badge?api-version=5.0-preview.2
GET https://dev.azure.com/{organization}/{project}/_apis/build/repos/{repoType}/badge?repoId={repoId}&branchName={branchName}&api-version=5.0-preview.2

URI Parameters

Name In Required Type Description
organization
path True
  • string

The name of the Azure DevOps organization.

project
path True
  • string

Project ID or project name

repoType
path True
  • string

The repository type.

repoId
query
  • string

The repository ID.

branchName
query
  • string

The branch name.

api-version
query True
  • string

Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.

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.