CHchecklyhq
Check sessions

Cancel a check session

Changed on

Cancels in-progress Playwright Check Suite runs within the specified check session. Use the optional sequenceId field in the request body to cancel only specific parallel runs within the session; omit it to cancel everything still running.

Returns 204 No Content once the cancellation requests have been dispatched. Returns 404 Not Found if the check session does not exist.

post/v1/check-sessions/{checkSessionId}/cancel

Request

Path parameters

checkSessionIdstring uuid required

Check session ID.

Headers

x-checkly-accountstring uuid

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

Request body

sequenceIdstring[]

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

Response

Cancellation accepted.

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status