CI & Test Runs

Run a test suite and wait for the result

Executes a test suite and returns the outcome in one call, which is what a pipeline step needs. The response tells you whether everything passed, so a CI job can fail on allPassed alone. Pass a reportFormat to get the report inline instead of downloading it separately.

The call blocks until the run finishes. For a long suite, send progressRunId and poll the status endpoint instead of holding the connection open.

post/api/cli/run

Request

  • Base URL: https://api.routebase.dev
  • URL: https://api.routebase.dev/api/cli/run
  • Auth: API key in header X-API-Key

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.

Request body

projectIdstring uuid required

Public id of the project.

suiteIdstring uuid required

Public id of the test suite to run.

environmentIdstring uuid nullable

Environment whose variables the run substitutes.

iterationsinteger nullable

How often to run the suite, between 1 and 10000. Defaults to 1.

delayMsinteger nullable

Pause between iterations in milliseconds, up to 60000. Defaults to 0.

onError'ignore' | 'stop' | 'abort'

What a run does when a test case errors. ignore continues, stop ends the current iteration but starts the next one, and abort ends the whole run.

reportFormat'json' | 'html' | 'junit' nullable

Include the report inline in the response in this format. Omit it to get no report.

threadsinteger nullable

Parallel threads for performance mode, between 1 and 50. Defaults to 1, which runs the cases in order and carries variables between them.

authOverrideJsonstring nullable

Authentication configuration that replaces the one stored on the suite, which lets a pipeline inject its own credentials.

Response

The run completed. Check allPassed for the verdict.

allPassedboolean required

Whether every test case passed across every iteration. Gate your build on this.

totalElapsedMsinteger required

Total run time in milliseconds.

totalTestsinteger required

Number of test case executions.

passedTestsinteger required

Number that passed.

failedTestsinteger required

Number that failed or errored.

testRunIdstring uuid nullable

Public id of the stored test run, which the report endpoints take.

iterationsinteger required

Number of iterations executed.

reportstring nullable

The report content, present only when reportFormat was requested.

reportFormatstring nullable

Format of the inline report.

reportContentTypestring nullable

MIME type of the inline report.

Changes

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