Skip to main content
POST
Permission Required: project:operate-runs
Stop one or more running tests. Only jobs belonging to your project will be stopped.

Request Body

job_ids
string[]
required
Array of job IDs to stop (minimum 1). Job IDs are returned when you start a run.

Response

ok
boolean
required
true if all jobs stopped successfully
message
string
required
Human-readable summary (e.g., “Successfully stopped 2 job(s)”)
received_count
integer
required
Number of job IDs provided in the request
stopped_count
integer
required
Number of jobs actually stopped
results
Result[]
required
Per-job results
Stopping a run will terminate it immediately. Any in-progress test steps will be marked as incomplete.

Authorizations

X-Api-Key
string
header
required

API key for authentication

Path Parameters

projectId
string
required

The project ID. You can copy it from the project settings page or the project URL in the dashboard.

Body

application/json
job_ids
string[]
required

Array of job IDs to stop

Minimum array length: 1

Response

All jobs stopped successfully

ok
boolean
message
string
received_count
integer
stopped_count
integer
results
object[]