With the Status Image API token, you can get an embeddable SVG badge image, a JSON message reflecting the status of the app, or a specific branch of the app.
-
Open your App on bitrise.io and click the badge image right next to the app’s name.
-
In the
Status imagepopup, you can optionally set a branch, and get copy-paste-readyEmbedcodes for the SVG image.An example for SVG URL:
https://app.bitrise.io/app/APP-ID/status.svg?token=STATUS-IMAGE-API-TOKEN&branch=masterTo get the JSON equivalent of the status image, simply replace the
.svgin theEmbedURL with.json.An example for JSON URL:
https://app.bitrise.io/app/APP-ID/status.json?token=STATUS-IMAGE-API-TOKEN&branch=master
JSON response ⚓
The JSON response returns a very simple JSON object:
{
"status": "SIMPLIFIED-STATUS-AS-TEXT"
}
where SIMPLIFIED-STATUS-AS-TEXT can be:
success: if the last finished build on the specified branch was successfulerror: if the last finished build failed or was aborted on the specified branchunknown: in any other case, including if there was no (finished) build on the specified branch
HTTP Codes and Errors ⚓
If the APP-ID and the STATUS-IMAGE-API-TOKEN parameters are correct,
and they identify an existing app, a 200 HTTP code is returned along with the JSON response, even if the branch parameter points to a non-existing branch (the JSON response in this case will be {"status": "unknown"} with a 200 HTTP code).
If the APP-ID or the STATUS-IMAGE-API-TOKEN (or both) is not correct,
you’ll get a HTTP 403 code with an empty response body.