Skip to main content

CircleCI

You may specify an optional token to get the status for a private repository.
If you need to use a token, please use a Project Token and only assign your token the 'Status' permission. Never use a Personal Token as they grant full read write permissions to your projects.
For more information about managing Circle CI tokens, please read this article.

Path Parameters
vcsType string — REQUIRED

Possible values: [github, gh, bitbucket, bb]

Example: github
user string — REQUIRED
Example: RedSparr0w
repo string — REQUIRED
Example: node-csgo-parser
branch string — REQUIRED
Example: master
Query Parameters
token string
Example: abc123def456
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. All simple-icons are referenced using icon slugs. 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.

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

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.