Cancels a check that is still queued and returns every credit held for it. A check that has started cannot be canceled.
- Key
- Bearer key, test or live
- Scope
checks:write- Idempotency
- Header recommended
Parameters
- idstringrequired
The id of the check.
Headers
- Idempotency-Keystringoptional
Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.
Response
200. The check, canceled.
- idstring
chk_...
- objectstring
check
- livemodeboolean
- statusstring
queuedrunningcompletedfailedcanceled
- modestring
textlink_check
- kindstring
checkrecheck
- sourcestring
apiconsolemonitor
- monitor_idstring or null
- client_domainstring
- page_countinteger
- project_idstring or null
The client project it is tagged to, in the same workspace; null when none.
- pagesarray of object
Empty until the check has completed.
Show child fields
- objectstring
page_result
- positioninteger
0-based, in the order you sent the pages.
- urlstring
The address you sent.
- verdictstring or null
null only when the check failed before this page ran.
VERIFIED_LIVELIVE_NO_FINGERPRINTNOT_LIVEUNVERIFIABLELINK_LIVELIVE_NO_LINK
- fetched_atstring or null
When we fetched the page (UTC). This is the age of the result.
- reusedboolean
True when the result comes from a fetch made in the last 15 minutes.
- final_urltext or unknown
- http_statusnumber or unknown
- registrable_domaintext or unknown
- textobject
- linksobject
- disclosureobject
- noindexyes/no or unknown
- canonical_urltext, null or unknown
- published_attext, null or unknown
- unknownsarray of object
Every unknown above, by dotted field name.
- chargedboolean
Whether this page was billed.
- rejectedarray of object
Addresses refused at submission. Never charged.
Show child fields
- inputstring
- codestring
See page rejection codes on the Errors page.
- summaryobject or null
- creditsobject
Show child fields
- heldinteger
- chargedinteger or null
- free_pagesinteger
- failure_codestring or null
- metadataobject
Your own notes: up to 20 keys, each key up to 40 characters, each value up to 500.
- created_atstring
- started_atstring or null
- completed_atstring or null
Errors
| Code | Status | Meaning |
|---|---|---|
missing_scope | 403 | The API key does not have the scope this endpoint needs. |
not_found | 404 | No such object. |
check_not_cancelable | 409 | Only a queued check can be canceled. |
Any request can also fail with missing_api_key, invalid_api_key, api_key_revoked, rate_limited or internal_error. See Errors.