Skip to main content

Azure DevOps builds (branch)

Azure Devops (formerly VSO, VSTS) is Microsoft Azure's CI/CD platform.

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 the PROJECT_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: 2

branch string — REQUIRED

Example: master

Query Parameters
stage string

Example: Successful Stage

job string

Example: Successful Job

style string

Possible values: [flat, flat-square, plastic, for-the-badge, social]

If not specified, the default style for this badge is "flat".

Example: flat

logo string

Icon slug from simple-icons. You can click the icon title on simple-icons to copy the slug or they can be found in the slugs.md file in the simple-icons repository. Further info.

Example: appveyor

logoColor string

The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.

Example: violet

logoSize string

Make icons adaptively resize by setting auto. Useful for some wider logos like amd and amg. Supported for simple-icons logos but not for custom logos.

Example: auto

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).

Example: abcdef

color string

Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors 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).

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.