API 2.1

Example: Your account is foo@example.com. The account on which you want to perform the API request is bar@example.com. You would authenticate as foo@example.com, with the Account‑Email header set to bar@example.com.

Request

> GET /checks HTTP/1.1
> Host: api.pingdom.com
> Authentication: Zm9vQGV4YW1wbGUuY29tOnBhc3N3b3Jk
> App-Key: 1234567890abcdef1234567890abcdef
> Account-Email: bar@example.com

Response

< HTTP/1.1 200 OK
< Content-Length: 13
< Content-Type: application/json

{"checks":[]}

The example prints the current status of all your checks. This sample obviously focuses on Pingdom API code and does not worry about any potential problems connecting to the API, but your code should.

Code

<?php
 
      // Init cURL
    $curl = curl_init();
      // Set target URL
    curl_setopt($curl, CURLOPT_URL, "https://api.pingdom.com/api/2.0/checks");
      // Set the desired HTTP method (GET is default, see the documentation for each request)
    curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
      // Set user (email) and password
    curl_setopt($curl, CURLOPT_USERPWD, "johndoe@example.com:password");
      // Add a http header containing the application key (see the Authentication section of this document)
    curl_setopt($curl, CURLOPT_HTTPHEADER, array("App-Key: zoent8w9cbt810rsdkweir23vcxb87zrt5541"));
      // Ask cURL to return the result as a string
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
 
      // Execute the request and decode the json result into an associative array
    $response = json_decode(curl_exec($curl),true);
 
      // Check for errors returned by the API
    if (isset($response['error'])) {
        print "Error: " . $response['error']['errormessage'] . "\n";
        exit;
    }
 
      // Fetch the list of checks from the response
    $checksList = $response['checks'];
      // Print the names and statuses of all checks in the list
    foreach ($checksList as $check) {
        print $check['name'] . " is " . $check['status'] . "\n";
    }
 
?>

Example output:

Ubuntu Packages is up
Google is up
Pingdom is up
My server 1 is down
My server 2 is up

If you are running PHP on Windows, you need to be sure that you have installed the CA certificates for HTTPS/SSL to work correctly. Please see the cURL manual for more information. As a quick (but unsafe) workaround, you can add the following cURL option to ignore certificate validation.

curl_setopt($curl,CURLOPT_SSL_VERIFYPEER, 0);

Get a list of the latest alerts.

Request

GET /api/2.1/actions?limit=2

Response

{
    "actions": {
        "alerts": [
            {
                "username" : "John Doe",
                "userid" : 111250,
                "checkid" : 241688,
                "time" : 1292248276,
                "via" : "sms",
                "status" : "delivered",
                "messageshort" : "up",
                "messagefull" : "PingdomAlert UP: MyCheck (example.com) is UP again at 2010-12-13 14:50:54. Downtime: 12m.",
                "sentto" : "46-555555",
                "charged" : true
            }, {
                "username" : "John Doe",
                "userid" : 111250,
                "checkid" : 241688,
                "time" : 1292248254,
                "via" : "email",
                "status" : "sent",
                "messageshort" : "up",
                "messagefull" : "FROM:alert@pingdom.com\r\nTO:john@example.com\r\nSubject:UP alert: MyCheck (example.com) is UP\r\n\r\nPingdomAlert UP:\r\nMyCheck (example.com) is UP again at 2010-12-13 14:50:54, after 12m of downtime.",
                "sentto" : "john@example.com",
                "charged" : false
            }
        ]
    }
}

Get a list of the latest analyses for check 161748

Request

GET /api/2.1/analysis/161748

Response

{
    "analysis" : [ {
        "id" : 28739021,
        "timefirsttest" : 1290441826,
        "timeconfirmtest" : 1290441865
    }, {
        "id" : 28737907,
        "timefirsttest" : 1290440924,
        "timeconfirmtest" : 1290440932
    }, {
        "id" : 28589686,
        "timefirsttest" : 1290263024,
        "timeconfirmtest" : 1290263059
    }, {
        "id" : 28063742,
        "timefirsttest" : 1289647724,
        "timeconfirmtest" : 1289647760
    } ]
}

Get all checks

Request

GET /api/2.1/checks&include_tags=true&tags=nginx,apache,ssh&limit=3

Response

{
    "checks": [
        {
            "hostname": "example.com",
            "id": 85975,
            "created": 1297181273,
            "lasterrortime": 1297446423,
            "lastresponsetime": 355,
            "lasttesttime": 1300977363,
            "name": "My check 1",
            "resolution": 1,
            "status": "up",
            "type": "http",
            "tags": [
                {
                    "name": "apache",
                    "type": "a",
                    "count": 2
                }
            ]
        },
        {
            "hostname": "mydomain.com",
            "id": 161748,
            "created": 1297181255,
            "lasterrortime": 1299194968,
            "lastresponsetime": 1141,
            "lasttesttime": 1300977268,
            "name": "My check 2",
            "resolution": 5,
            "status": "up",
            "type": "ping",
            "tags": [
                {
                    "name": "nginx",
                    "type": "u",
                    "count": 1
                }
            ]
        },
        {
            "hostname": "example.net",
            "id": 208655,
            "created": 1297181243,
            "lasterrortime": 1300527997,
            "lastresponsetime": 800,
            "lasttesttime": 1300977337,
            "name": "My check 3",
            "resolution": 1,
            "status": "down",
            "type": "http",
            "tags": [
                {
                    "name": "apache",
                    "type": "a",
                    "count": 2
                }
            ]
        }
    ],
    "counts": {
        "total": 55,
        "limited": 3,
        "filtered": 5
    }
}

Get detailed information about check 85975

Request

GET /api/2.1/checks/85975

Response

{
  "check" : {
    "id" : 85975,
    "name" : "My check 7",
    "resolution" : 1,
    "sendnotificationwhendown" : 0,
    "notifyagainevery" : 0,
    "notifywhenbackup" : false,
    "created" : 1240394682,
    "type" : {
      "http" : {
        "url" : "/",
        "port" : 80,
        "requestheaders" : {
          "User-Agent" : "Pingdom.com_bot_version_1.4_(http://www.pingdom.com/)"
          "Cookie": ["sessionid=123", "lastvisited=1293142347"]
        }
      }
    },
    "hostname" : "s7.mydomain.com",
    "status" : "up",
    "lasterrortime" : 1293143467,
    "lasttesttime" : 1294064823
  }
}

Create a new HTTP check for www.mydomain.com with default settings

Request

POST /api/2.1/checks

body:

name=My+new+HTTP+check&type=http&host=www.mydomain.com

Response

{
   "check":{
      "id":138631,
      "name":"My new HTTP check"
   }
}

Create a new SMTP check for smtp.mymailserver.com with SSL/TLS encryption, provided user/password, 15 minutes check resolution, with SMS and email alerts to contacts 123456 and 789012 after 1 down result

Request

POST /api/2.1/checks

body:

name=My+new+SMTP+check&type=smtp&resolution=15&sendnotificationwhendown=1&userids=123456,789012&host=smtp.mymailserver.com&auth=myuser%3Amypassword&encryption=true

Response

{
   "check":{
      "id":138632,
      "name":"My new SMTP check"
   }
}

Change user/password and resolution on SMTP check 138632

Request

PUT /api/2.1/checks/138632

body:

auth=newuser%3Anewpassword&resolution=30

Response

{
   "message":"Modification of check was successful!"
}

Pause check 138632

Request

PUT /api/2.1/checks/138632

body:

paused=true

Response

{
   "message":"Modification of check was successful!"
}

Pause all checks

Request

PUT /api/2.1/checks

body:

paused=true

Response

{
  "message" : "Modification of 4 checks was successful!"
}

Resume all checks

Request

PUT /api/2.1/checks

body:

paused=false

Response

{
  "message" : "Modification of 4 checks was successful!"
}

Permanently delete check 134536

Request

DELETE /api/2.1/checks/134536

Response

{
   "message":"Deletion of check was successful!"
}

Permanently delete checks 134536, 134539 and 134551

Request

DELETE /api/2.1/checks

body:

delcheckids=134536,134539,134551

Response

{
   "message":"Deletion of checks was successful!"
}

Get credits list

Request

GET /api/2.1/credits

Response

{
    "credits": {
        "checklimit": 18,
        "availablechecks": 5,
        "useddefault": 6,
        "usedtransaction": 7,
        "availablesms": 20,
        "availablesmstests": 7,
        "autofillsms": false,
        "autofillsms_amount": 0,
        "autofillsms_when_left": 0,
        "max_sms_overage": 50,
        "availablerumsites": 4,
        "usedrumsites": 1,
        "maxrumfilters": 10,
        "maxrumpageviews": 100000
    }
}

Get all user's maintenance windows

Request

GET /api/2.1/maintenance

Response

{
   "maintenance": [
        {
            "id": 1,
            "description": "Maintenance window from DB",
            "from": 1497520800,
            "to": 1497574800,
            "recurrencetype": "none",
            "repeatevery": 0,
            "effectiveto": 1497574800,
            "checks": {
                "uptime": [506206, 506233, 222],
                "tms": [123, 111]
            }
        },
        {
            "id": 2,
            "description": "Another maintenance window from DB",
            "from": 1497574800,
            "to": 1497578400,
            "recurrencetype": "none",
            "repeatevery": 0,
            "effectiveto": 1497578400,
            "checks": {
                "uptime": [],
                "tms": []
            }
        }
   ]
}

Get maintenance window detail

Request

GET /api/2.1/maintenance/456

Response

{
    "maintenance": {
        "id": 456,
        "description": "Particular maintenance window",
        "from": 1497520800,
        "to": 1497574800,
        "recurrencetype": "none",
        "repeatevery": 0,
        "effectiveto": 1497574800,
        "checks": {
            "uptime": [506206, 506233, 222],
            "tms": [123, 111]
        }
    }
}

Create new maintenance window

Request

POST /api/2.1/maintenance

body:

description=Some%20description%20of%20the%20maintenance%20window&from=1500471702&to=1500475302

Response

{
    "maintenance": {
        "id": 666
    }
}

Modify the maintenance window

Request

PUT /api/2.1/maintenance/12345

body:

description=Modified%20maintenance%20window

Response

{
    "message": "Maintenance window successfully modified!"
}

Delete the maintenance window 12345

Request

DELETE /api/2.1/maintenance/12345

Response

{
    "message": "Maintenance window successfully deleted!"
}

Delete the maintenance windows 1, 2, 3, 4 and 5

Request

DELETE /api/2.1/maintenance

body:

maintenanceids=1,2,3,4,5

Response

{
   "message":"5 maintenance windows successfully deleted."
}

Get the detail of occurrence 57

Request

GET /api/2.1/maintenance.occurrences/57

Response

{
    "occurrence": {
        "id": 57,
        "maintenanceid": 44,
        "from": 1501714800,
        "to": 1501719300
    }
}

Get the occurrences of the maintenance windows 44 that are effective from 2017-08-02T00:00:00 to 2017-08-02T23:59:59

Request

GET /api/2.1/maintenance.occurrences?maintenanceid=44&from=1501632000&to=1501718399

Response

{
   "occurrences": [
        {
            "id": 455,
            "maintenanceid": 44,
            "from": 1501628400,
            "to": 1501632900,
        },
        {
            "id": 456,
            "maintenanceid": 44,
            "from": 1501714800,
            "to": 1501719300,
        }
   ]
}

Modify the maintenance occurrence 666

Request

PUT /api/2.1/maintenance.occurrences/666

body:

from=1500471702&to=1500475302

Response

{
    "message": "Occurrence successfully modified!"
}

Delete the maintenance window occurrence 666

Request

DELETE /api/2.1/maintenance.occurrences/666

Response

{
    "message": "Occurrence successfully deleted!"
}

Delete the occurrences 1, 2, 3, 4 and 5

Request

DELETE /api/2.1/maintenance.occurrences

body:

occurrenceids=1,2,3,4,5

Response

{
   "message":"5 occurrences successfully deleted."
}

Get all (existing) probes

Request

GET /api/2.1/probes

Response

{
   "probes":[
      {
         "id":1,
         "country":"United Kingdom",
         "city":"Manchester",
         "name":"Manchester, UK",
         "active":true,
         "hostname":"s424.pingdom.com",
         "ip":"212.84.74.156",
         "countryiso":"GB"
      },
      {
         "id":2,
         "country":"United States",
         "city":"New York",
         "name":"New York, NY",
         "active":true,
         "hostname":"s413.pingdom.com",
         "ip":"70.32.40.2"
         "countryiso":"US"
      },
      {
         "id":3,
         "country":"Denmark",
         "city":"Copenhagen",
         "name":"Copenhagen, Denmark",
         "active":true,
         "hostname":"s416.pingdom.com",
         "ip":"82.103.128.63"
         "countryiso":"DK"
      }
   ]
}

Request

GET /api/2.1/reference

Response

{
  "regions" : [ {
    "id" : 2,
    "description" : "United States (Alaska)"
  }, {
    "id" : 1,
    "description" : "United States (Hawaii)"
  }, {
    "id" : 3,
    "description" : "United States (Pacific Time)"
  }, {
    "id" : 4,
    "description" : "United States (Mountain Time)"
  }, {
    "id" : 5,
    "description" : "United States (Central Time)"
  }, {
    "id" : 6,
    "description" : "United States (Eastern Time)"
  }, {
    "id" : 7,
    "description" : "Sweden"
  }, {
    "id" : 8,
    "description" : "United Kingdom"
  }, {
    "id" : 9,
    "description" : "India"
  }, {
    "id" : 10,
    "description" : "Canada (Pacific Time)"
  }, {
    "id" : 11,
    "description" : "Canada (Mountain Time)"
  }, {
    "id" : 12,
    "description" : "Canada (Central Time)"
  }, {
    "id" : 13,
    "description" : "Canada (Eastern Time)"
  }, {
    "id" : 14,
    "description" : "Canada (Atlantic Time)"
  }, {
    "id" : 15,
    "description" : "Canada (Newfoundland)"
  }, {
    "id" : 16,
    "description" : "China"
  }, {
    "id" : 17,
    "description" : "Australia (Adelaide)"
  }, {
    "id" : 18,
    "description" : "Australia (Canberra, Melbourne, Sydney)"
  }, {
    "id" : 19,
    "description" : "Turkey"
  }, {
    "id" : 20,
    "description" : "Spain"
  }, {
    "id" : 21,
    "description" : "Brazil (Eastern Time)"
  }, {
    "id" : 22,
    "description" : "Brazil (Atlantic Time)"
  }, {
    "id" : 23,
    "description" : "Brazil (Brazil, Buenos Aires, Georgetown)"
  }, {
    "id" : 24,
    "description" : "Brazil (Mid-Atlantic)"
  }, {
    "id" : 25,
    "description" : "Indonesia (Bangkok, Hanoi, Jakarta)"
  }, {
    "id" : 26,
    "description" : "Indonesia (Beijing, Perth, Singapore, Hong Kong)"
  }, {
    "id" : 27,
    "description" : "Indonesia (Tokyo, Seoul, Osaka)"
  }, {
    "id" : 28,
    "description" : "Romania"
  }, {
    "id" : 29,
    "description" : "Mexico (Pacific Time)"
  }, {
    "id" : 30,
    "description" : "Mexico (Mountain Time)"
  }, {
    "id" : 31,
    "description" : "Mexico (Central Time)"
  }, {
    "id" : 32,
    "description" : "Bulgaria"
  }, {
    "id" : 33,
    "description" : "Portugal (Azores)"
  }, {
    "id" : 34,
    "description" : "Portugal (Western Europe Time, London, Lisbon)"
  }, {
    "id" : 35,
    "description" : "Egypt"
  }, {
    "id" : 36,
    "description" : "Italy"
  }, {
    "id" : 37,
    "description" : "Pakistan"
  }, {
    "id" : 38,
    "description" : "France"
  }, {
    "id" : 39,
    "description" : "New Zealand"
  }, {
    "id" : 40,
    "description" : "Australia (Lord Howe Island)"
  }, {
    "id" : 41,
    "description" : "New Zealand (Chatham Islands)"
  }, {
    "id" : 42,
    "description" : "Germany"
  }, {
    "id" : 43,
    "description" : "Saudi Arabia"
  }, {
    "id" : 44,
    "description" : "Australia (Perth)"
  } ],
  "timezones" : [ {
    "id" : 1,
    "description" : "(GMT -12:00) Eniwetok, Kwajalein"
  }, {
    "id" : 2,
    "description" : "(GMT -11:00) Midway Island, Samoa"
  }, {
    "id" : 3,
    "description" : "(GMT -10:00) Hawaii"
  }, {
    "id" : 4,
    "description" : "(GMT -9:00) Alaska"
  }, {
    "id" : 5,
    "description" : "(GMT -8:00) Pacific Time (US & Canada)"
  }, {
    "id" : 6,
    "description" : "(GMT -7:00) Mountain Time (US & Canada)"
  }, {
    "id" : 7,
    "description" : "(GMT -6:00) Central Time (US & Can.), Mexico"
  }, {
    "id" : 8,
    "description" : "(GMT -5:00) Eastern Time (US & Can.)"
  }, {
    "id" : 9,
    "description" : "(GMT -4:00) Atlantic Time (Can.)"
  }, {
    "id" : 10,
    "description" : "(GMT -3:30) Newfoundland"
  }, {
    "id" : 11,
    "description" : "(GMT -3:00) Brazil, Buenos Aires, Georgetown"
  }, {
    "id" : 12,
    "description" : "(GMT -2:00) Mid-Atlantic"
  }, {
    "id" : 13,
    "description" : "(GMT -1:00 hour) Azores"
  }, {
    "id" : 14,
    "description" : "(GMT) Western Europe Time, London, Lisbon"
  }, {
    "id" : 15,
    "description" : "(GMT +1:00 hour) Brussels, Copenhagen, Madrid"
  }, {
    "id" : 16,
    "description" : "(GMT +2:00) Athens, Cairo"
  }, {
    "id" : 17,
    "description" : "(GMT +3:00) Baghdad, Moscow, Riyadh"
  }, {
    "id" : 18,
    "description" : "(GMT +3:30) Tehran"
  }, {
    "id" : 19,
    "description" : "(GMT +4:00) Abu Dhabi, Muscat"
  }, {
    "id" : 20,
    "description" : "(GMT +4:30) Kabul"
  }, {
    "id" : 21,
    "description" : "(GMT +5:00) Islamabad, Karachi"
  }, {
    "id" : 22,
    "description" : "(GMT +5:30) Bombay, Calcutta, Colombo, New Delhi"
  }, {
    "id" : 23,
    "description" : "(GMT +6:00) Almaty, Dhaka"
  }, {
    "id" : 24,
    "description" : "(GMT +7:00) Bangkok, Hanoi, Jakarta"
  }, {
    "id" : 25,
    "description" : "(GMT +8:00) Beijing, Perth, Singapore, Hong Kong"
  }, {
    "id" : 26,
    "description" : "(GMT +9:00) Tokyo, Seoul, Osaka"
  }, {
    "id" : 27,
    "description" : "(GMT +9:30) Adelaide"
  }, {
    "id" : 28,
    "description" : "(GMT +10:00) Canbera, Melbourne, Sydney"
  }, {
    "id" : 29,
    "description" : "(GMT +11:00) Solomon Isl., New Caledonia"
  }, {
    "id" : 30,
    "description" : "(GMT +12:00) Auckland, Fiji, Kamchatka"
  }, {
    "id" : 32,
    "description" : "(GMT +10:30) Lord Howe Island"
  }, {
    "id" : 33,
    "description" : "(GMT +12:45) Chatham Islands"
  }, {
    "id" : 34,
    "description" : "(GMT +10:00) Brisbane"
  }, {
    "id" : 35,
    "description" : "(GMT +13:00) New Zealand Daylight Time, Tonga"
  }, {
    "id" : 36,
    "description" : "(GMT) Reykjavik"
  }, {
    "id" : 37,
    "description" : "(GMT +2:00) South African Standard Time"
  }, {
    "id" : 38,
    "description" : "(GMT -4:30) Caracas"
  }, {
    "id" : 39,
    "description" : "(GMT -6:00) Central America, El Salvador"
  } ],
  "datetimeformats" : [ {
    "id" : 1,
    "description" : "07/31/2006 02:45:05pm"
  }, {
    "id" : 2,
    "description" : "31/07/2006 02:45:05pm"
  }, {
    "id" : 3,
    "description" : "31/07/2006 14:45:05"
  }, {
    "id" : 4,
    "description" : "2006-07-31 14:45:05"
  }, {
    "id" : 5,
    "description" : "31.07.2006. 14:45:05"
  }, {
    "id" : 6,
    "description" : "31/07/2006 14h45m05"
  }, {
    "id" : 7,
    "description" : "31-07-2006 02:45:05pm"
  }, {
    "id" : 8,
    "description" : "31-07-2006 14:45:05"
  } ],
  "numberformats" : [ {
    "id" : 1,
    "description" : "123,456,789.00"
  }, {
    "id" : 2,
    "description" : "123 456 789.00"
  }, {
    "id" : 3,
    "description" : "123456789.00"
  }, {
    "id" : 4,
    "description" : "123.456.789,00"
  }, {
    "id" : 5,
    "description" : "123 456 789,00"
  }, {
    "id" : 6,
    "description" : "123456789,00"
  } ]
}

Request

GET /api/2.1/reports.email

Response

{
  "subscriptions" : [ {
    "id" : 114979,
    "name" : "My subscription",
    "type" : "overview",
    "frequency" : "monthly",
    "include_paused": 1
  } ]
}

Request

POST /api/2.1/reports.email

body:

name=My+subscription&frequency=weekly&userids=123456,134253

Response

{
   "message":"Subscription added"
}

Request

PUT /api/2.1/reports.email/634253

body:

name=My+subscription+modified&frequency=monthly

Response

{
   "message":"Subscription modified"
}

Request

DELETE /api/2.1/reports.email/634253

Response

{
   "message":"Subscription deleted"
}

Request

GET /api/2.1/reports.public

Response

{
  "public" : [ {
    "checkid" : 85975,
    "checkname" : "ubuntu packages",
    "reporturl" : "http://www.pingdom.com/reports/rwknj2rkd39h/check_overview/?name=ubuntu+packages"
  } ]
}

Request

PUT /api/2.1/reports.public/123456

Response

{
    "message":"Check published"
}

Request

DELETE /api/2.1/reports.public/123456

Response

{
    "message":"Check unpublished"
}

Request

GET /api/2.1/reports.shared

Response

{
  "shared" : {
    "banners" : [ {
      "id" : "9338512f",
      "name" : "mydomain.com",
      "checkid" : 241688,
      "auto" : true,
      "type" : "uptime",
      "url" : "http://share.pingdom.com/banners/9338512f"
    }, {
      "id" : "476a37ba",
      "name" : "myotherdomain.com",
      "checkid" : 241688,
      "auto" : true,
      "type" : "uptime",
      "url" : "http://share.pingdom.com/banners/476a37ba"
    } ]
  }
}

Request

POST /api/2.1/reports.shared

body:

sharedtype=banner&checkid=123456

Response

{
    "message":"Banner created"
}

Request

DELETE /api/2.1/reports.shared/476a37ba

Response

{
   "message":"Banner deleted"
}

Get the 5 latest results for check 85975

Request

GET /api/2.1/results/85975?limit=5

Response

{
  "results" : [ {
  "probeid" : 33,
  "time" : 1294235764,
  "status" : "up",
  "responsetime" : 91,
  "statusdesc" : "OK",
  "statusdesclong" : "OK"
  }, {
  "probeid" : 34,
  "time" : 1294235703,
  "status" : "up",
  "responsetime" : 442,
  "statusdesc" : "OK",
  "statusdesclong" : "OK"
  }, {
  "probeid" : 35,
  "time" : 1294235643,
  "status" : "up",
  "responsetime" : 187,
  "statusdesc" : "OK",
  "statusdesclong" : "OK"
  }, {
  "probeid" : 36,
  "time" : 1294235583,
  "status" : "up",
  "responsetime" : 403,
  "statusdesc" : "OK",
  "statusdesclong" : "OK"
  }, {
  "probeid" : 37,
  "time" : 1294235523,
  "status" : "up",
  "responsetime" : 111,
  "statusdesc" : "OK",
  "statusdesclong" : "OK"
  } ],
  "activeprobes" : [ 33, 34, 35, 36, 37 ]
  }

Request

GET /api/2.1/servertime

Response

{
  "servertime" : 1294237910
}

Request

GET /api/2.1/settings

Response

{
    "settings" : {
      "firstname" : "John",
      "lastname" : "Smith",
      "company" : "Pingdom",
      "email" : "johndoe@pingdom.com",
      "phone" : "",
      "cellphone" : "46-555555555",
      "address" : "Pingdom Street 1",
      "address2" : "",
      "zip" : "55555",
      "location" : "Pingdom City",
      "state" : "",
      "external_reference": "",
      "description" : "My Personal Account",
      "autologout" : false,
      "country" : {
        "name" : "Sweden",
        "iso" : "SE"
      },
      "region" : "Sweden",
      "timezone" : {
        "id" : "CET",
        "description" : "(GMT +1:00 hour) Brussels, Copenhagen, Madrid"
      },
      "dateformat" : "%Y-%m-%d",
      "timeformat" : "%H:%M:%S",
      "numberformat" : ", ",
      "numberexample" : "123 456 789,00"
    }
  }

Change company name to Pingdom and state to Neverland

Request

PUT /api/2.1/settings

body:

company=Pingdom&state=Neverland

Response

{
  "message":"Settings updated successfully"
  }

Request

GET /api/2.1/single?host=pingdom.com&type=http&probeid=17

Response

{
  "result" : {
    "status" : "up",
    "responsetime" : 73,
    "statusdesc" : "OK",
    "statusdesclong" : "OK",
    "probeid" : 17,
    "probedesc" : "Stockholm, Sweden"
  }
}

Request

GET /api/2.1/summary.average/85975

body:

includeuptime=true

Response

{
  "summary" : {
    "responsetime" : {
      "from" : 0,
      "to" : 1294245352,
      "avgresponse" : 458
    },
    "status" : {
      "totalup" : 53072286,
      "totaldown" : 771879,
      "totalunknown" : 1240401138
    }
  }
}

Request

GET /api/2.1/summary.average/85975

body:

bycountry=true

Response

{
  "summary" : {
    "responsetime" : {
      "from" : 0,
      "to" : 1294245226,
      "avgresponse" : [ {
        "countryiso" : "SE",
        "avgresponse" : 250
      }, {
        "countryiso" : "US",
        "avgresponse" : 650
      }, {
        "countryiso" : "GB",
        "avgresponse" : 129
      }, {
        "countryiso" : "CA",
        "avgresponse" : 442
      }, {
        "countryiso" : "NL",
        "avgresponse" : 162
      }, {
        "countryiso" : "DE",
        "avgresponse" : 200
      }, {
        "countryiso" : "DK",
        "avgresponse" : 229
      }, {
        "countryiso" : "FR",
        "avgresponse" : 204
      }, {
        "countryiso" : "ES",
        "avgresponse" : 285
      } ]
    }
  }
}

Get averages for the last week

Request

GET /api/2.1/summary.hoursofday/85975

Response

{
  "hoursofday" : [ {
    "hour" : 0,
    "avgresponse" : 259
  }, {
    "hour" : 1,
    "avgresponse" : 299
  }, {
    "hour" : 2,
    "avgresponse" : 259
  }, {
    "hour" : 3,
    "avgresponse" : 327
  }, {
    "hour" : 4,
    "avgresponse" : 302
  },
    "hour" : 5,
    "avgresponse" : 376
  },
    "hour" : 6,
    "avgresponse" : 256
  },
    "hour" : 7,
    "avgresponse" : 262
  },
    "hour" : 8,
    "avgresponse" : 328
  },
    "hour" : 9,
    "avgresponse" : 335
  },
    "hour" : 10,
    "avgresponse" : 276
  }, {
    "hour" : 11,
    "avgresponse" : 291
  }, {
    "hour" : 12,
    "avgresponse" : 287
  }, {
    "hour" : 13,
    "avgresponse" : 267
  }, {
    "hour" : 14,
    "avgresponse" : 276
  }, {
    "hour" : 15,
    "avgresponse" : 266
  }, {
    "hour" : 16,
    "avgresponse" : 326
  }, {
    "hour" : 17,
    "avgresponse" : 292
  }, {
    "hour" : 18,
    "avgresponse" : 301
  }, {
    "hour" : 19,
    "avgresponse" : 270
  }, {
    "hour" : 20,
    "avgresponse" : 282
  }, {
    "hour" : 21,
    "avgresponse" : 262
  }, {
    "hour" : 22,
    "avgresponse" : 270
  }, {
    "hour" : 23,
    "avgresponse" : 253
  } ]
}

Request

GET /api/2.1/summary.outage/85975

Response

{
  "summary" : {
    "states" : [ {
      "status" : "up",
      "timefrom" : 1293143523,
      "timeto" : 1294180263
    }, {
      "status" : "down",
      "timefrom" : 1294180263,
      "timeto" : 1294180323
    }, {
      "status" : "up",
      "timefrom" : 1294180323,
      "timeto" : 1294223466
    }, {
      "status" : "down",
      "timefrom" : 1294223466,
      "timeto" : 1294223523
    }, {
      "status" : "up",
      "timefrom" : 1294223523,
      "timeto" : 1294228503
    }, {
      "status" : "down",
      "timefrom" : 1294228503,
      "timeto" : 1294228563
    }, {
      "status" : "up",
      "timefrom" : 1294228563,
      "timeto" : 1294228623
    }, {
      "status" : "down",
      "timefrom" : 1294228623,
      "timeto" : 1294228743
    }, {
      "status" : "up",
      "timefrom" : 1294228743,
      "timeto" : 1294228803
    }, {
      "status" : "down",
      "timefrom" : 1294228803,
      "timeto" : 1294228987
    }, {
      "status" : "up",
      "timefrom" : 1294228987,
      "timeto" : 1294229047
    }, {
      "status" : "down",
      "timefrom" : 1294229047,
      "timeto" : 1294229583
    }, {
      "status" : "up",
      "timefrom" : 1294229583,
      "timeto" : 1294229643
    }, {
      "status" : "down",
      "timefrom" : 1294229643,
      "timeto" : 1294230063
    }, {
      "status" : "up",
      "timefrom" : 1294230063,
      "timeto" : 1294389243
    } ]
  }
}

Request

GET /api/2.1/summary.performance/85975?includeuptime=true&resolution=week

Response

{
  "summary" : {
    "weeks" : [ {
      "starttime" : 1287957600,
      "avgresponse" : 468,
      "uptime" : 608400,
      "downtime" : 0,
      "unmonitored" : 0
    }, {
      "starttime" : 1288566000,
      "avgresponse" : 467,
      "uptime" : 604620,
      "downtime" : 180,
      "unmonitored" : 0
    }, {
      "starttime" : 1289170800,
      "avgresponse" : 440,
      "uptime" : 604680,
      "downtime" : 120,
      "unmonitored" : 0
    }, {
      "starttime" : 1289775600,
      "avgresponse" : 451,
      "uptime" : 604680,
      "downtime" : 120,
      "unmonitored" : 0
    }, {
      "starttime" : 1290380400,
      "avgresponse" : 456,
      "uptime" : 604680,
      "downtime" : 120,
      "unmonitored" : 0
    }, {
      "starttime" : 1290985200,
      "avgresponse" : 465,
      "uptime" : 604496,
      "downtime" : 304,
      "unmonitored" : 0
    }, {
      "starttime" : 1291590000,
      "avgresponse" : 489,
      "uptime" : 604610,
      "downtime" : 190,
      "unmonitored" : 0
    }, {
      "starttime" : 1292194800,
      "avgresponse" : 466,
      "uptime" : 604800,
      "downtime" : 0,
      "unmonitored" : 0
    }, {
      "starttime" : 1292799600,
      "avgresponse" : 452,
      "uptime" : 604680,
      "downtime" : 120,
      "unmonitored" : 0
    }, {
      "starttime" : 1293404400,
      "avgresponse" : 447,
      "uptime" : 604800,
      "downtime" : 0,
      "unmonitored" : 0
    }, {
      "starttime" : 1294009200,
      "avgresponse" : 465,
      "uptime" : 382511,
      "downtime" : 1437,
      "unmonitored" : 0
    } ]
  }
}

Request

GET /api/2.1/summary.probes/85975?from=1294393564&to=1294394816

Response

{
  "probes" : [ 43, 42, 41, 40, 39, 37, 36, 35, 34, 33, 32, 31, 30, 29, 28, 27, 24, 23, 22, 21 ]
}

Get all teams

Request

GET /api/2.1/teams

Response

{
    "teams": [
        {
            "id": "1",
            "name": "Team Rocket",
            "users": [
                {
                    "id": "1",
                    "email": "giovanni@team-rocket.org",
                    "name": "Giovanni"
                }
            ]
        },
        {
            "id": "2",
            "name": "The A-Team",
            "users": [
                {
                    "id": "2",
                    "email": "hannibal@ateam.org",
                    "name": "John \"Hannibal\" Smith"
                },
                {
                    "id": "3",
                    "email": "faceman@ateam.org",
                    "name": "Templeton \"Face(man)\" Peck"
                }
            ]
        }
    ]
}

Get team 1

Request

GET /api/2.1/teams/1

Response

{
    "team": {
        "id": "1",
        "name": "Team Rocket",
        "users": [
            {
                "id": "1",
                "email": "giovanni@team-rocket.org",
                "name": "Giovanni"
            }
        ]
    }
}

Create a new team

Request

POST /api/2.1/teams

body:

name=Operations&userids=10034512,10043154

Response

{
    "id": 65,
    "name": "Operations",
    "users": [
        {
            "id": "10034512",
            "email": "hannibal@ateam.org",
            "name": "John \"Hannibal\" Smith"
        },
        {
            "id": "10043154",
            "email": "faceman@ateam.org",
            "name": "Templeton \"Face(man)\" Peck"
        }
    ]
}

Create a new team

Request

PUT /api/2.1/teams/1234

body:

name=Operations&userids=10034512,10043154

Response

{
    "id": 65,
    "name": "Operations",
    "users": [
        {
            "id": "10034512",
            "email": "hannibal@ateam.org",
            "name": "John \"Hannibal\" Smith"
        },
        {
            "id": "10043154",
            "email": "faceman@ateam.org",
            "name": "Templeton \"Face(man)\" Peck"
        }
    ]
}

Delete teams

Request

DELETE /api/2.1/teams/1234

Response

{
    "success": true
}

Request

GET api/2.1/traceroute?host=pingdom.com&probeid=23

Response

{
  "traceroute" : {
    "result" : "traceroute to pingdom.com (83.140.19.136), 30 hops max, 40 byte packets\n 1  67.192.120.130 (67.192.120.130)  4.803 ms  5.000 ms  5.202 ms\n 2  67.192.56.2 (67.192.56.2)  0.332 ms  0.352 ms  0.431 ms\n 3  vlan905.edge4.dfw1.rackspace.com (67.192.56.228)  0.384 ms  0.444 ms  0.497 ms\n 4  12.87.41.177 (12.87.41.177)  1.926 ms  1.983 ms *\n 5  cr1.dlstx.ip.att.net (12.122.139.122)  3.696 ms  3.725 ms  3.741 ms\n 6  dlstx01jt.ip.att.net (12.122.80.41)  1.792 ms  1.817 ms  1.840 ms\n 7  192.205.34.82 (192.205.34.82)  1.668 ms  1.828 ms 192.205.34.142 (192.205.34.142)  1.722 ms\n 8  RIX-TELECOM-AB.TenGigabitEthernet9-3.ar2.ANR3.gblx.net (64.208.169.138)  147.221 ms  146.710 ms  146.473 ms\n 9  po41-20g-r86.cr1-r85.hy-sto.se.p80.net (82.96.1.162)  146.334 ms  146.347 ms  146.776 ms\n10  83.140.54.18.cust.port80.se (83.140.54.18)  146.741 ms  146.311 ms  146.283 ms\n11  83.140.19.136 (83.140.19.136)  146.789 ms  146.710 ms  146.795 ms\n",
    "probeid" : 23,
    "probedescription" : "Dallas 4, TX"
  }
}

Get all users

Request

GET /api/2.1/users

Response

{
  "users": [
    {
      "id": 1,
      "name": "User 1",
      "paused": "NO",
      "sms": [
        {
          "id": 1,
          "severity": "HIGH",
          "country_code": "46",
          "number": "71234567",
          "provider": "nexmo"
        }
      ],
      "email": [
        {
          "id": 2,
          "severity": "HIGH",
          "address": "user1@example.com"
        }
      ]
    },
    {
      "id": 2,
      "name": "User 2",
      "paused": "YES",
      "sms": [
        {
          "id": 4,
          "severity": "HIGH",
          "country_code": "46",
          "number": "709876543",
          "provider": "nexmo"
        }
      ]
    }
  ]
}

Create a new user

Request

POST /api/2.1/users

body:

name=User1

Response

{
   "user": {
        "id": 3
   }
}

Change name and primary status for user 3

Request

PUT /api/2.1/users/3

body:

name=Updated%20Name&primary=YES

Response

{
   "message":"Modification of user was successful!"
}

Change email on contact target 11 for user 3

Request

POST /api/2.1/users/3/11

body:

email=anotheresampleemail@example.com

Response

{
   "message":"Modification of contact target was successful!"
}

Permanently delete user 1

Request

DELETE /api/2.1/users/1

Response

{
   "message":"Deletion of user was successful!"
}

Permanently delete contact target 2 for user 1

Request

DELETE /api/2.1/users

Response

{
   "message":"Deletion of contact target successful"
}

Create a contact target for user 3

Request

POST /api/2.1/users/3

body:

email=example1@example.com&number=0701234567&countrycode=46&provider=nexmo&severitylevel=high

Response

{
   "contact_target": {
        "id": 11
   }
}