Skip to main content
New to Corsair? See API access, authentication, and error handling.

Contact Groups

create

contactGroups.create Create a contact group to alert when a check fails Risk: write
Input Output

delete

contactGroups.delete Permanently delete a contact group; checks using it keep running but no longer alert it Risk: destructive · Irreversible
Input Output

get

contactGroups.get Get one contact group by ID Risk: read
Input Output

list

contactGroups.list List contact groups with their email addresses, mobile numbers and integrations, paged Risk: read
Input Output

update

contactGroups.update Change a contact group’s name, addresses, numbers, integrations or ping URL; only the fields passed change Risk: write
Input Output

Heartbeat

create

heartbeat.create Create a heartbeat check that alerts when a job stops pinging its URL Risk: write
Input Output

delete

heartbeat.delete Permanently delete a heartbeat check; this cannot be undone Risk: destructive · Irreversible
Input Output

get

heartbeat.get Get one heartbeat check with its last tested time and uptime Risk: read
Input Output

list

heartbeat.list List heartbeat (cron monitoring) checks with their status and uptime, filtered by state or tags and paged Risk: read
Input Output

update

heartbeat.update Change a heartbeat check’s name, period, contact groups, host, paused state or tags; only the fields passed change Risk: write
Input Output

Locations

pagespeed

locations.pagespeed List monitoring locations pagespeed checks can run from Risk: read
Input Output

uptime

locations.uptime List monitoring locations uptime checks can run from, with their current status Risk: read
Input Output

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
Input Output

delete

maintenanceWindows.delete Permanently delete a maintenance window; alerts resume immediately Risk: destructive · Irreversible
Input Output

get

maintenanceWindows.get Get one maintenance window by ID Risk: read
Input Output

list

maintenanceWindows.list List maintenance windows with their state and schedule, paged Risk: read
Input Output

update

maintenanceWindows.update Change a maintenance window’s schedule, timezone, repeat interval, covered checks or tags; only the fields passed change Risk: write
Input Output

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
Input Output

delete

pagespeed.delete Permanently delete a pagespeed check; this cannot be undone Risk: destructive · Irreversible
Input Output

get

pagespeed.get Get one pagespeed check with its latest stats Risk: read
Input Output

history

pagespeed.history Read recorded pagespeed results (loadtime, filesize, requests) newest first, in a time window with a next link for paging Risk: read
Input Output

list

pagespeed.list List pagespeed checks with their latest stats, paged Risk: read
Input Output

update

pagespeed.update Change a pagespeed check’s target, rate, region, alert thresholds or paused state; only the fields passed change Risk: write
Input Output

Ssl

create

ssl.create Create an SSL check that alerts before a certificate expires Risk: write
Input Output

delete

ssl.delete Permanently delete an SSL check; this cannot be undone Risk: destructive · Irreversible
Input Output

get

ssl.get Get one SSL check with certificate dates, issuer, scores and mixed content Risk: read
Input Output

list

ssl.list List SSL checks with certificate validity, scores and flags, paged Risk: read
Input Output

update

ssl.update Change an SSL check’s target, rate, alerting or paused state; only the fields passed change Risk: write
Input Output

Uptime

alerts

uptime.alerts Read the alerts a check sent, newest first, in a time window with a next link for paging Risk: read
Input Output

create

uptime.create Create an uptime check for a URL, domain or port, with content checks, basic auth, regions and alert settings Risk: write
Input Output

delete

uptime.delete Permanently delete an uptime check; this cannot be undone Risk: destructive · Irreversible
Input Output

get

uptime.get Get one uptime check with its full configuration and status Risk: read
Input Output

history

uptime.history Read recorded check results (loadtime, status code) newest first, in a time window with a next link for paging Risk: read
Input Output

list

uptime.list List uptime checks with type, status and uptime percentage, filtered by state or tags and paged Risk: read
Input Output

periods

uptime.periods Read the check up/down periods, newest first, in a time window with a next link for paging Risk: read
Input Output

update

uptime.update Change an uptime check’s configuration; only the fields passed change. Sending a field empty clears it Risk: write
Input Output