CI & Test Runs

Execute a test suite

Runs every test case in a suite in order, carrying extracted variables from one case into the next. This is the full result shape, so it also carries the per-case detail, the seed results and the performance metrics that /api/cli/run leaves out.

Set persistResults to false for a dry run that leaves no test run behind.

post/api/projects/{projectId}/test-suites/{suiteId}/execute

Request

  • Base URL: https://api.routebase.dev
  • URL: https://api.routebase.dev/api/projects/{projectId}/test-suites/{suiteId}/execute
  • Auth: API key in header X-API-Key

Path parameters

ProjectIdstring uuid required

Public id of the project.

suiteIdstring uuid required

Public id of the test suite.

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

environmentIdstring uuid nullable

Environment whose variables the run substitutes.

persistResultsboolean nullable

Whether to store the run and its results. Defaults to true.

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.

dataSetIdstring uuid nullable

Data set for data-driven execution, which runs every case once per row.

threadsinteger nullable

Parallel threads for performance mode, between 1 and 50. Defaults to 1.

progressRunIdstring uuid nullable

Client-generated id for live progress. Join the test-runner hub group for this id before sending the request, then follow the run case by case.

caseIdsstring[] nullable

Run only these test cases. Null or empty runs the whole suite.

Response

The run completed.

extractedVariablesobject required

Variables extracted during the run and carried between cases.

allPassedboolean required

Whether every case passed.

totalElapsedMsinteger required

Total run time in milliseconds.

testRunPublicIdstring uuid nullable

Public id of the stored run, or null when results were not persisted.

iterationsinteger required

Number of iterations executed.

dataSetNamestring nullable

Name of the data set, for a data-driven run.

dataRowCountinteger nullable

Number of data rows used.

threadsinteger required

Threads the run used.

Changes

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