Pingdom

App · 20 actions

Monitor uptime checks, results, outages, alert contacts and maintenance windows.

Actions

ActionWhat it does
Create http checkCreates an HTTP uptime check for a host with a name, and optionally how often it runs and whether it starts paused.
Create maintenanceCreates a maintenance window with a description, start and end time, and optionally the checks to pause during it.
Delete checkDeletes a check by its check ID, which stops its monitoring.
Delete maintenanceDeletes a maintenance window by its ID, so its checks are no longer paused during that time.
Get checkGets one check by its check ID, including its host, type, status, resolution and last test results.
Get contactGets one alerting contact by its contact ID, including their email and phone notification targets.
Get creditsGets your Pingdom account's credits, such as how many checks and SMS alerts you have used and have left.
Get maintenanceGets one maintenance window by its ID, including its description, start and end times and the checks it covers.
Get performanceGets a check's response times and uptime grouped by hour, day or week over a time range, by check ID.
Get teamGets one alerting team by its team ID, including its name and members.
Get uptime summaryGets a check's average response time over a time range, by check ID, optionally with uptime totals and broken down by country or probe.
List alertsLists the alerts Pingdom has sent, optionally filtered by time, check, user, delivery status or channel.
List checksLists the uptime checks in your Pingdom account, optionally filtered by tags, with each check's ID, name, host and current status.
List contactsLists the alerting contacts in your account, with each contact's ID, name and how they are notified.
List maintenanceLists your maintenance windows, sorted as you choose, with each window's ID, description, times and checks.
List outagesLists the up and down periods of a check, by check ID, within an optional time range.
List probesLists the probe servers Pingdom tests from, optionally only active ones, with each probe's location and IP address.
List resultsLists the raw test results of a check, by check ID, optionally filtered by time, probe, status or response time.
List teamsLists the alerting teams in your account, with each team's ID, name and members.
Update checkChanges a check's name, host, test interval or paused state, by its check ID.

Create http check

Creates an HTTP uptime check for a host with a name, and optionally how often it runs and whether it starts paused. Returns the new check's ID.

Inputs

NamenametextRequired
Check name
HosthosttextRequired
Target host
Pausedpausedtrue/false
Paused.Default: false.
Resolutionresolutionnumber
How often should the check be tested? (minutes)One of: 1, 5, 15, 30, 60. Default: 5.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "check": {
      "id": 1,
      "name": "example"
    }
  }
}

Create maintenance

Creates a maintenance window with a description, start and end time, and optionally the checks to pause during it. Returns the new window's ID.

Inputs

DescriptiondescriptiontextRequired
Description
Start timestart_timedate and timeRequired
Start time.
End timeend_timedate and timeRequired
End time.
Uptimeidsuptimeidslist
Identifiers of uptime checks to assign to the maintenance window - Comma separated Integers

Outputs

dataobject
Response.
Example output
{
  "data": {
    "maintenance": {
      "id": 1
    }
  }
}

Delete check

Deletes a check by its check ID, which stops its monitoring.

Inputs

Checkcheck_idnumberRequired
Check ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Delete maintenance

Deletes a maintenance window by its ID, so its checks are no longer paused during that time.

Inputs

Maintenance IDmaintenance_idnumberRequired
Maintenance ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get check

Gets one check by its check ID, including its host, type, status, resolution and last test results.

Inputs

Checkcheck_idnumberRequired
Check ID.
Include teamsinclude_teamstrue/false
Include teams.Default: false.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "check": {
      "hostname": "example",
      "id": 1,
      "name": "example",
      "paused": false,
      "resolution": 1,
      "status": "example"
    }
  }
}

Get contact

Gets one alerting contact by its contact ID, including their email and phone notification targets.

Inputs

Contact IDcontact_idnumberRequired
Contact ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get credits

Gets your Pingdom account's credits, such as how many checks and SMS alerts you have used and have left.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get maintenance

Gets one maintenance window by its ID, including its description, start and end times and the checks it covers.

Inputs

Maintenance IDmaintenance_idnumberRequired
Maintenance ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "maintenance": {
      "description": "example",
      "id": 1
    }
  }
}

Get performance

Gets a check's response times and uptime grouped by hour, day or week over a time range, by check ID.

Inputs

Checkcheck_idnumberRequired
Check ID.
From timefrom_timedate and time
From time.
To timeto_timedate and time
To time.
Resolutionresolutiontext
Resolution.One of: hour, day, week. Default: hour.
Includeuptimeincludeuptimetrue/false
Includeuptime.Default: false.
Probesprobestext
Probes.
Orderordertext
Order.One of: asc, desc. Default: asc.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get team

Gets one alerting team by its team ID, including its name and members.

Inputs

Alert team IDalert_team_idnumberRequired
Alert team ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get uptime summary

Gets a check's average response time over a time range, by check ID, optionally with uptime totals and broken down by country or probe.

Inputs

Checkcheck_idnumberRequired
Check ID.
From timefrom_timedate and time
From time.
To timeto_timedate and time
To time.
Probesprobestext
Probes.
Includeuptimeincludeuptimetrue/false
Includeuptime.Default: false.
Bycountrybycountrytrue/false
Bycountry.Default: false.
Byprobebyprobetrue/false
Byprobe.Default: false.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List alerts

Lists the alerts Pingdom has sent, optionally filtered by time, check, user, delivery status or channel. Returns one page; use the paging fields for the next page.

Inputs

From timefrom_timedate and time
From time.
To timeto_timedate and time
To time.
Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Offsetoffsetnumber
Offset.From 0 to 1000000. Default: 0.
Checkidscheckidstext
Checkids.
Useridsuseridstext
Userids.
Statusstatustext
Status.
Viaviatext
Via.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List checks

Lists the uptime checks in your Pingdom account, optionally filtered by tags, with each check's ID, name, host and current status. Returns one page; use the paging fields for the next page.

Inputs

Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Offsetoffsetnumber
Offset.From 0 to 1000000. Default: 0.
Showencryptionshowencryptiontrue/false
Showencryption.Default: false.
Include tagsinclude_tagstrue/false
Include tags.Default: false.
Include severityinclude_severitytrue/false
Include severity.Default: false.
Tagstagstext
Tags.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "checks": []
  }
}

List contacts

Lists the alerting contacts in your account, with each contact's ID, name and how they are notified.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "contacts": []
  }
}

List maintenance

Lists your maintenance windows, sorted as you choose, with each window's ID, description, times and checks. Returns one page; use the paging fields for the next page.

Inputs

Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Offsetoffsetnumber
Offset.From 0 to 1000000.
Orderbyorderbytext
Orderby.One of: description, from, to, effectiveto.
Orderordertext
Order.One of: asc, desc. Default: asc.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "maintenance": []
  }
}

List outages

Lists the up and down periods of a check, by check ID, within an optional time range.

Inputs

Checkcheck_idnumberRequired
Check ID.
From timefrom_timedate and time
From time.
To timeto_timedate and time
To time.
Orderordertext
Order.One of: asc, desc. Default: asc.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List probes

Lists the probe servers Pingdom tests from, optionally only active ones, with each probe's location and IP address. Returns one page; use the paging fields for the next page.

Inputs

Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Offsetoffsetnumber
Offset.From 0 to 1000000. Default: 0.
Onlyactiveonlyactivetrue/false
Onlyactive.Default: false.
Includedeletedincludedeletedtrue/false
Includedeleted.Default: false.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List results

Lists the raw test results of a check, by check ID, optionally filtered by time, probe, status or response time. Returns one page; use the paging fields for the next page.

Inputs

Checkcheck_idnumberRequired
Check ID.
To timeto_timedate and time
To time.
From timefrom_timedate and time
From time.
Probesprobestext
Default: all probes
Statusstatustext
Default: all statuses
Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Offsetoffsetnumber
Offset.From 0 to 1000000. Default: 0.
Includeanalysisincludeanalysistrue/false
Includeanalysis.Default: false.
Maxresponsemaxresponsenumber
Maxresponse.
Minresponseminresponsenumber
Minresponse.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List teams

Lists the alerting teams in your account, with each team's ID, name and members.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "teams": []
  }
}

Update check

Changes a check's name, host, test interval or paused state, by its check ID.

Inputs

Checkcheck_idnumberRequired
Check ID.
Namenametext
Check name
Hosthosttext
Target host
Pausedpausedtrue/false
Paused.Default: false.
Resolutionresolutionnumber
How often should the check be tested? (minutes)One of: 1, 5, 15, 30, 60. Default: 5.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

On this page