Skip to main content
POST
/
api
/
test-runs
/
{id}
/
cancel
Cancel a test run
curl --request POST \
  --url https://api.empirical.run/api/test-runs/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
{
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required

Database ID of the test run.

Required range: x >= 1

Body

application/json
​
reason
string

Optional reason for cancelling the test run. Recorded for auditing purposes.

Response

The test run was cancelled.

​
message
string
required

Confirmation message indicating the test run was cancelled.