Cancel a running scan

POST

/v1/track/scans/{id}/cancel

POST

/v1/track/scans/{id}/cancel

Cancelled before any point, the scan costs nothing: its points come back. A finished scan answers its status.

Scope: track:run.

Authorization

headerAuthorizationBearer <rstk_… API key or OAuth access token>

A Track API key (rstk_…, Settings → API & MCP) or an OAuth access token issued for this API

id*string

Scan id (gs_…). A malformed id is 404 not_found.

Match^gs_[A-Za-z0-9]{10,40}$

application/json

ok*boolean

status*string

The scan's status now

Value in"done""failed""cancelled"

Example Request

curl -X POST 'https://panel.rankshark.io/v1/track/scans/gs_3Hq7Vt2NwR8cYp/cancel'

Example Request

curl -X POST 'https://panel.rankshark.io/v1/track/scans/gs_3Hq7Vt2NwR8cYp/cancel'

Example ResponseSchema

{
  "ok": true,
  "status": "cancelled"
}

{  "ok": true,  "status": "cancelled"}