Runs
Query and manage test runs.
A run represents a single execution of your test suite. Runs contain spec files which are executed across multiple instances. You can query run details, cancel runs, reset failed specs, and delete runs.
Get a single run by ID with full details
API key authentication using Bearer token
The run ID
run_abc123Successful response
Invalid request parameters
Authentication failed
Resource not found
Delete a run and all associated data
API key authentication using Bearer token
The run ID
run_abc123Run deleted successfully
Invalid request parameters
Authentication failed
Resource not found
Find a run by query parameters. Returns the most recent completed run matching the criteria.
API key authentication using Bearer token
The project ID
proj_abc123The CI build ID. If provided, returns the run with this exact ciBuildId.
Git branch name. Used when ciBuildId is not provided.
Run tags to filter by (can be specified multiple times)
If true, includes information about failed tests from the last run (Playwright only)
Successful response
Invalid request parameters
Authentication failed
Resource not found
Cancel a run in progress
API key authentication using Bearer token
The run ID
run_abc123Run cancelled successfully
Invalid request parameters
Authentication failed
Resource not found
Reset failed spec files in a run to allow re-execution. Requires specifying machineId(s) to reset.
API key authentication using Bearer token
The run ID
run_abc123Machine ID(s) to reset
Whether to use batched orchestration
Run reset successfully
Invalid request parameters
Authentication failed
Resource not found
Cancel a run by GitHub Actions workflow run ID and attempt number
API key authentication using Bearer token
GitHub Actions workflow run ID
GitHub Actions workflow run attempt number
Optional project ID to scope the cancellation
Optional CI build ID to scope the cancellation
Run cancelled successfully
Invalid request parameters
Authentication failed
Resource not found
Last updated
Was this helpful?