List checks

GET

/api/v1/checks

Docs menu

Your checks, newest first, without their pages. Filter by status or by the monitor that made them.

Key
Bearer key, test or live
Scope
read

Parameters

statusstringoptional

Only checks in this state.

queuedrunningcompletedfailedcanceled

monitor_idstringoptional

Only checks made by this monitor.

limitintegeroptional

How many objects to return, 1 to 100. Default 20.

Default: 20

starting_afterstringoptional

The id of the last object you have. Returns the objects after it. Newest first.

Response

200. A page of checks.

objectstring

list

dataarray of object
Show child fields
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.

rejectedarray of object

Addresses refused at submission. Never charged.

summaryobject or null
creditsobject
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
has_moreboolean
next_starting_afterstring or null

Pass this as starting_after to read the next page.

Errors

CodeStatusMeaning
missing_scope403The API key does not have the scope this endpoint needs.
parameter_invalid400A parameter has a value this endpoint does not accept.
limit_invalid400The limit must be a whole number from 1 to 100.
cursor_invalid400The starting_after cursor does not name an object in this list.

Any request can also fail with missing_api_key, invalid_api_key, api_key_revoked, rate_limited or internal_error. See Errors.

In test mode