Skip to main content

Azure DevOps builds (job)

A badge requires three pieces of information: ORGANIZATION,PROJECT_ID and DEFINITION_ID.

To start, edit your build definition and look at the url:

ORGANIZATION is after the dev.azure.com part, PROJECT_NAME is right after that, DEFINITION_ID is at the end after the id= part.

Then use the Azure DevOps REST API to translate thePROJECT_NAME to a PROJECT_ID.

Navigate to https://dev.azure.com/ORGANIZATION/_apis/projects/PROJECT_NAME

PROJECT_ID is in the id property of the API response.
Path Parameters
organization string — REQUIRED
Example: totodem
projectId string — REQUIRED
Example: 8cf3ec0e-d0c2-4fcd-8206-ad204f254a96
definitionId string — REQUIRED
Example: 5
branch string — REQUIRED
Query Parameters
stage string
Example: Successful Stage
job string
Example: Successful Job
style string

One of: flat (default), flat-square, plastic, for-the-badge, social

Example: flat
logo string

One of the named logos (bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. Simple-icons are referenced using icon slugs which can be found on the simple-icons site or in the slugs.md file in the simple-icons repository.

Example: appveyor
logoColor string

The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored.

Example: violet
label string

Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!)

Example: healthiness
labelColor string

Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorA" is also supported.

Example: abcdef
color string

Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorB" is also supported.

Example: fedcba
cacheSeconds string

HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored). The legacy name "maxAge" is also supported.

Example: 3600
link string[]

Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an <object> HTML tag, but not an <img> tag or a markup language.