Runs API
List all runs
Returns a paginated list of runs in a test suite.
curl -H "Authorization: Bearer $TOKEN" \
-X GET "https://api.buildkite.com/v2/analytics/organizations/{org.slug}/suites/{suite.slug}/runs"
[
{
"id": "64374307-12ab-4b13-a3f3-6a408f644ea2",
"branch": "main",
"commit_sha": "1c3214fcceb2c14579a2c3c50cd78f1442fd8936",
"state": "finished",
"result": "passed",
"url": "https://api.buildkite.com/v2/analytics/organizations/my_great_org/suites/my_suite_slug/runs/64374307-12ab-4b13-a3f3-6a408f644ea2",
"web_url": "https://buildkite.com/organizations/my_great_org/analytics/suites/my_suite_slug/runs/64374307-12ab-4b13-a3f3-6a408f644ea2",
"created_at": "2023-06-25T05:32:53.228Z"
}
]
Optional query string parameters:
build_id
|
Filters the results by the given build UUID.
Example: |
|---|
Required scope: read_suites
Success response: 200 OK
Get a run
curl -H "Authorization: Bearer $TOKEN" \
-X GET "https://api.buildkite.com/v2/analytics/organizations/{org.slug}/suites/{suite.slug}/runs/{run.id}"
{
"id": "64374307-12ab-4b13-a3f3-6a408f644ea2",
"branch": "main",
"commit_sha": "1c3214fcceb2c14579a2c3c50cd78f1442fd8936",
"state": "finished",
"result": "passed",
"url": "https://api.buildkite.com/v2/analytics/organizations/my_great_org/suites/my_suite_slug/runs/64374307-12ab-4b13-a3f3-6a408f644ea2",
"web_url": "https://buildkite.com/organizations/my_great_org/analytics/suites/my_suite_slug/runs/64374307-12ab-4b13-a3f3-6a408f644ea2",
"created_at": "2023-06-25T05:32:53.228Z"
}
Required scope: read_suites
Success response: 200 OK
Runs are created with a state of running and proceed to finished when all uploads have been processed. The run may return to running if additional results are uploaded.
Run result starts as pending and will proceed to passed or failed when at least one test result has been processed. The presence of a passed or failed result does not indicate that the run has finished processing. result may change from passed to failed if additional results are uploaded. The result is failed when there is at least one failing test in the run, and it is not possible for result to change from failed. If a run receives no results within a reasonable time period its result will proceed to stale.