Skip to main content
POST
/
v1
/
test-sessions
/
{testSessionId}
/
cancel
Cancel a test session
curl --request POST \
  --url https://api.checklyhq.com/v1/test-sessions/{testSessionId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sequenceId": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://checklyhq.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Test sessions are recorded with checkly test, checkly trigger, and checkly pw-test. Cancellation applies only to the session’s Playwright Check Suite runs — any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs continue until they finish normally. See Cancellation for how cancelled runs affect alerts, metrics, and the CANCELLED session status.

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string<uuid>

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Path Parameters

​
testSessionId
string<uuid>
required

Test session ID.

Body

application/json
​
sequenceId
string<uuid>[]

Subset of sequence IDs to cancel. Omit to cancel all in-progress sequences.

Minimum array length: 1

Response

Cancellation accepted.