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

Alerting

contacts.create

alerting.contacts.create Create an alerting contact with notification targets Risk: write
Input notificationTargets each take email, or number with countryCode, plus severity HIGH or LOW; Pingdom wants at least one HIGH and one LOW target.
Output

contacts.delete

alerting.contacts.delete Delete an alerting contact Risk: destructive
Input Output

contacts.get

alerting.contacts.get Read one alerting contact Risk: read
Input Output

contacts.list

alerting.contacts.list List the alerting contacts Risk: read
Input: empty object Output

contacts.update

alerting.contacts.update Modify an alerting contact Risk: write
Input
Output

teams.create

alerting.teams.create Create an alerting team Risk: write
Input Output

teams.delete

alerting.teams.delete Delete an alerting team Risk: destructive
Input Output

teams.get

alerting.teams.get Read one alerting team Risk: read
Input Output

teams.list

alerting.teams.list List the alerting teams Risk: read
Input: empty object Output

teams.update

alerting.teams.update Modify an alerting team Risk: write
Input Output

Analysis

get

analysis.get Read one raw root cause analysis Risk: read
Input Output: empty object

list

analysis.list List the latest root cause analyses of a check Risk: read
Input Output

Checks

create

checks.create Create an uptime check of any documented type Risk: write
Input type is one of http, httpcustom, tcp, ping, dns, udp, smtp, pop3, imap; typeSettings carries the flat type-specific fields from the docs (http: url, encryption, port, shouldcontain, shouldnotcontain, postdata, requestheaders, verify_certificate, ssl_down_days_before; tcp: port, encryption, stringtoexpect; dns: nameserver, expectedip). Output

delete

checks.delete Delete a check Risk: destructive
Input Output

deleteMulti

checks.deleteMulti Delete several checks at once Risk: destructive
Input Output

get

checks.get Read one check with its type settings Risk: read
Input Output

list

checks.list List the checks with paging and tag filters Risk: read
Input Output

update

checks.update Modify the settings of one check Risk: write
Input Output

updateMulti

checks.updateMulti Pause, unpause or re-time the listed checks at once Risk: write
Input Pauses, unpauses or re-times the checks listed in checkIds, in one call. Without checkIds Pingdom would change every check, so the plugin requires the list. Output

Maintenance

create

maintenance.create Create a maintenance window Risk: write
Input recurrenceType is none, day, week or month, with repeatEvery; from and to must be later than the request time; effectiveTo 0 means the recurrence never stops. Output

delete

maintenance.delete Delete a maintenance window Risk: destructive
Input Output

deleteMulti

maintenance.deleteMulti Delete several maintenance windows at once Risk: destructive
Input Output

get

maintenance.get Read one maintenance window Risk: read
Input Output

list

maintenance.list List the maintenance windows Risk: read
Input Output

update

maintenance.update Modify a maintenance window Risk: write
Input Output

Occurrences

delete

occurrences.delete Delete a maintenance occurrence Risk: destructive
Input Output

get

occurrences.get Read one maintenance occurrence Risk: read
Input Output

list

occurrences.list List maintenance occurrences Risk: read
Input Output

update

occurrences.update Move a maintenance occurrence Risk: write
Input Output

Results

list

results.list List the raw test results of a check Risk: read
Input status filters to up, down, unconfirmed or unknown; probes takes a comma-separated probe id list. Output

Summaries

average

summaries.average Read the average time and uptime summary of a check Risk: read
Input Output

hoursOfDay

summaries.hoursOfDay Read the per-hour response time summary Risk: read
Input Output

outage

summaries.outage Read the status change history of a check Risk: read
Input Output

performance

summaries.performance Read the per-interval performance summary Risk: read
Input Output

probes

summaries.probes Read the per-probe test counts of a check Risk: read
Input Output

Tools

getCredits

tools.getCredits Read the account check slots and SMS credits Risk: read
Input: empty object Output

getReference

tools.getReference Read region, timezone and format references Risk: read
Input: empty object Output: empty object

listActions

tools.listActions List the alert actions across checks Risk: read
Input Output

listProbes

tools.listProbes List the Pingdom probe servers Risk: read
Input Output

runSingle

tools.runSingle Run a one-off check against a host Risk: write
Input Performs a single test without creating a check; the answer carries status, responsetime and the probe that ran it. Output