BuildMaster Documentation

Badges

  • Last Modified: 2019-04-24

Badge API

BuildMaster allows external tools to query build status in order to generate a "CI Badge", such as:

To access the CI Badge API, an API key must be added with access to the API. Then, the following URLs can be used to generate either the badge image or a link to the corresponding build/execution:

Image:

{buildmaster-host}/api/ci-badges/image?API_Key={yourApiKey}&$ApplicationName={appName}

Link:

{buildmaster-host}/api/ci-badges/link?API_Key={yourApiKey}&$ApplicationName={appName}

The badge specifiers are not limited to applications and may be further filtered based on commit IDs, branches, and more. For more information on how to configure and query a badge, visit the CI Badge API documentation.

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.