Skip to main content

Get Build Badge

GET /badge/:author/:repository/:branch/:build

Get the badge of the specific build of a project.
This is not a standard API endpoint. It will return a svg.

Path parameters

NameTypeDescription
authorstringThe project author.
repositorystringThe project repository.
branchstringThe project branch.
buildnumber"latest"

Response

The response will always be a svg image with HTTP 200 status code.

The text will be in English by default. By passing Accept-Language header, you can get the text in other languages if available.
The available languages are: en-US, zh-CN.
The resolver will try to find the best match language. If no match is found, it will fallback to English.

A successful build will look like this:

Successful build

A failed build will look like this:

Failed build

If the build is not found, it will look like this:

Build not found