Contact Groups
create
contactGroups.create
Create a contact group to alert when a check fails
Risk: write
data full type
data full type
delete
contactGroups.delete
Permanently delete a contact group; checks using it keep running but no longer alert it
Risk: destructive · Irreversible
get
contactGroups.get
Get one contact group by ID
Risk: read
data full type
data full type
list
contactGroups.list
List contact groups with their email addresses, mobile numbers and integrations, paged
Risk: read
data full type
data full type
metadata full type
metadata full type
update
contactGroups.update
Change a contact group’s name, addresses, numbers, integrations or ping URL; only the fields passed change
Risk: write
Heartbeat
create
heartbeat.create
Create a heartbeat check that alerts when a job stops pinging its URL
Risk: write
data full type
data full type
delete
heartbeat.delete
Permanently delete a heartbeat check; this cannot be undone
Risk: destructive · Irreversible
get
heartbeat.get
Get one heartbeat check with its last tested time and uptime
Risk: read
data full type
data full type
list
heartbeat.list
List heartbeat (cron monitoring) checks with their status and uptime, filtered by state or tags and paged
Risk: read
data full type
data full type
metadata full type
metadata full type
update
heartbeat.update
Change a heartbeat check’s name, period, contact groups, host, paused state or tags; only the fields passed change
Risk: write
Locations
pagespeed
locations.pagespeed
List monitoring locations pagespeed checks can run from
Risk: read
data full type
data full type
uptime
locations.uptime
List monitoring locations uptime checks can run from, with their current status
Risk: read
data full type
data full type
Maintenance Windows
create
maintenanceWindows.create
Create a maintenance window that silences chosen uptime checks, by ID or by tags, for a time period
Risk: write
data full type
data full type
delete
maintenanceWindows.delete
Permanently delete a maintenance window; alerts resume immediately
Risk: destructive · Irreversible
get
maintenanceWindows.get
Get one maintenance window by ID
Risk: read
data full type
data full type
list
maintenanceWindows.list
List maintenance windows with their state and schedule, paged
Risk: read
data full type
data full type
metadata full type
metadata full type
update
maintenanceWindows.update
Change a maintenance window’s schedule, timezone, repeat interval, covered checks or tags; only the fields passed change
Risk: write
Pagespeed
create
pagespeed.create
Create a pagespeed check that runs from a chosen region and can alert on page size or load time
Risk: write
data full type
data full type
delete
pagespeed.delete
Permanently delete a pagespeed check; this cannot be undone
Risk: destructive · Irreversible
get
pagespeed.get
Get one pagespeed check with its latest stats
Risk: read
data full type
data full type
history
pagespeed.history
Read recorded pagespeed results (loadtime, filesize, requests) newest first, in a time window with a next link for paging
Risk: read
data full type
data full type
links full type
links full type
metadata full type
metadata full type
list
pagespeed.list
List pagespeed checks with their latest stats, paged
Risk: read
data full type
data full type
metadata full type
metadata full type
update
pagespeed.update
Change a pagespeed check’s target, rate, region, alert thresholds or paused state; only the fields passed change
Risk: write
Ssl
create
ssl.create
Create an SSL check that alerts before a certificate expires
Risk: write
data full type
data full type
delete
ssl.delete
Permanently delete an SSL check; this cannot be undone
Risk: destructive · Irreversible
get
ssl.get
Get one SSL check with certificate dates, issuer, scores and mixed content
Risk: read
data full type
data full type
list
ssl.list
List SSL checks with certificate validity, scores and flags, paged
Risk: read
data full type
data full type
metadata full type
metadata full type
update
ssl.update
Change an SSL check’s target, rate, alerting or paused state; only the fields passed change
Risk: write
Uptime
alerts
uptime.alerts
Read the alerts a check sent, newest first, in a time window with a next link for paging
Risk: read
data full type
data full type
links full type
links full type
create
uptime.create
Create an uptime check for a URL, domain or port, with content checks, basic auth, regions and alert settings
Risk: write
data full type
data full type
delete
uptime.delete
Permanently delete an uptime check; this cannot be undone
Risk: destructive · Irreversible
get
uptime.get
Get one uptime check with its full configuration and status
Risk: read
data full type
data full type
history
uptime.history
Read recorded check results (loadtime, status code) newest first, in a time window with a next link for paging
Risk: read
data full type
data full type
links full type
links full type
list
uptime.list
List uptime checks with type, status and uptime percentage, filtered by state or tags and paged
Risk: read
data full type
data full type
metadata full type
metadata full type
periods
uptime.periods
Read the check up/down periods, newest first, in a time window with a next link for paging
Risk: read
data full type
data full type
links full type
links full type
update
uptime.update
Change an uptime check’s configuration; only the fields passed change. Sending a field empty clears it
Risk: write