CI & Test Runs

Get the progress of a test run

Returns how far a run has come, which lets a pipeline show progress instead of waiting silently. While the run is going, currentDurationMs counts up and completedAt stays null.

get/api/cli/runs/{id}/status

Request

  • Base URL: https://api.routebase.dev
  • URL: https://api.routebase.dev/api/cli/runs/{id}/status
  • Auth: API key in header X-API-Key

Path parameters

idstring uuid required

Public id of the test run.

Headers

X-RB-Regionstring
Example:us

Region of your organization. US organizations must send us; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.

Response

The current status of the run.

idstring uuid required

Public id of the test run.

status'pending' | 'running' | 'passed' | 'failed' | 'error' | 'cancelled' required

Current state of the run.

completedCasesinteger required

Test cases finished so far.

totalCasesinteger required

Test cases in the run.

passedCasesinteger required

Test cases that passed.

failedCasesinteger required

Test cases that failed.

currentDurationMsinteger required

Elapsed time, which counts up while the run is going and is final once it ends.

startedAtstring date-time required

When the run started.

completedAtstring date-time nullable

When the run ended, or null while it is still going.

Changes

No recorded changes to this operation across all 1 revision of this API.