Retrieve a monitor

GET

/api/v1/monitors/{id}

Docs menu

One monitor, with when it runs next and which check it made last.

Key
Bearer key, test or live
Scope
read

Parameters

idstringrequired

The id of the monitor.

Response

200. The monitor.

idstring

mon_...

objectstring

monitor

livemodeboolean
statusstring

activepausedended

pause_codestring or null

insufficient_balancelimit_reachedby_requesthost_opted_out

schedulestring

dailyweeklyday7_day30

modestring

textlink_check

client_domainstring
pagesarray of string
source_check_idstring or null
notify_emailboolean

Email a summary when a page changes. Off by default for monitors made by API, on for monitors made in the console.

next_run_atstring or null
last_run_atstring or null
last_check_idstring or null
runs_completedinteger
ends_atstring

Every schedule has an end: daily 90 days, weekly 365 days, day7_day30 at day 30.

metadataobject

Your own notes: up to 20 keys, each key up to 40 characters, each value up to 500.

created_atstring
ended_atstring or null
project_idstring or null

The client project it is tagged to, in the same workspace; null when none.

Errors

CodeStatusMeaning
missing_scope403The API key does not have the scope this endpoint needs.
not_found404No such object.

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