Your monitors, newest first.
- Key
- Bearer key, test or live
- Scope
read
Parameters
- statusstringoptional
Only monitors in this state.
activepausedended
- 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 monitors.
- objectstring
list
- dataarray of object
Show child fields
- 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.
- has_moreboolean
- next_starting_afterstring or null
Pass this as starting_after to read the next page.
Errors
| Code | Status | Meaning |
|---|---|---|
missing_scope | 403 | The API key does not have the scope this endpoint needs. |
parameter_invalid | 400 | A parameter has a value this endpoint does not accept. |
limit_invalid | 400 | The limit must be a whole number from 1 to 100. |
cursor_invalid | 400 | The 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.