Monitors your websites every 5 minutes, totally free.

Add up to 50 websites. Get alerts by e-mail, SMS, Twitter, RSS or push notifications for iPhone/iPad.

API Shortcuts

• Introduction
• Authentication
• Formats
• Methods
  • getMonitors
  • newMonitor
  • editMonitor
  • deleteMonitor
  • getAlertContacts
  • newAlertContact
  • deleteAlertContact
• Parameters
• Error Messages
• Example PHP Code
• (Unofficial) Resources
• Tighter Integration For Apps & Services

API

Uptime Robot has a very easy-to-use API.

Responses are provided as either XML, JSON or JSON-P.

It lets you get the details of your monitors, logs and create/edit monitors (or remove existing ones).

That's all.

Authentication

HTTP Basic Access Authentication is used for verifying accounts.

There are 2 types of apiKeys for reaching the data:

• account-specific apiKey which allows using all the API methods on all the monitors of an account
• monitor-specific apiKeys which allows using only the getMonitors method for the givenmonitor

Which apiKey type to use?

account-specific apiKey is good for pulling data for more than 1 monitors (like listing the stats of all monitors) and/or adding-editing-deleting monitors.

monitor-specific apiKeys are good for pulling data for a single monitor without revealing your main apiKey (account-specific apiKey). For ex: you can use monitor-specific apiKeys in client websites (so you'll still be able to pull data and the client will only be able to see the monitor-specific apiKey).

Where to find the apiKeys?

They are found under "My Settings" page.

While making a request, send the apiKey in your request just like:

apiKey=u956-afus321g565fghr519 (check example requests below).

Formats

Responses can either be XML or JSON. Just mention the preferred format as:

format=xml or format=json

Once a JSON response is requested, the response comes with a callback function named jsonUptimeRobotApi by default, just like:

jsonUptimeRobotApi({...});

If you only need the raw JSON response without a function wrapper, send the noJsonCallback parameter with a value of 1, like:

noJsonCallback=1 will result in {...}

Methods

Methods are defined just after the API URL (for ex: http://api.uptimerobot.com/methodName). And, here they are:

getMonitors

This is a Swiss-Army knife type of a method for getting any information on monitors.

By default, it lists all the monitors in a user's account, their friendly names, types (http, keyword, port, etc.), statuses (up, down, etc.) and uptime ratios.

There are optional parameters which lets the GetMonitors method to output information on any given monitors rather than all of them.

And also, parameters exist for getting the notification logs (alerts) for each monitor and even which alert contacts were alerted on each notification.

Parameters

• apiKey - required
• monitors - optional (if not used, will return all monitors in an account. Else, it is possible to define any number of monitors with their IDs like: monitors=15830-32696-83920)
• customUptimeRatio - optional (defines the number of days to calculate the uptime ratio(s) for. Ex: customUptimeRatio=7-30-45 to get the uptime ratios for those periods)
• logs - optional (defines if the logs of each monitor will be returned. Should be set to 1 for getting the logs. Default is 0)
• alertContacts - optional (defines if the notified alert contacts of each notification will be returned. Should be set to 1 for getting them. Default is 0. Requires logs to be set to1)
• showMonitorAlertContacts - optional (defines if the alert contacts set for the monitor to be returned. Default is 0.

Example Request And Response

        jsonUptimeRobotApi({
            "stat": "ok",
            "monitors": {
                "monitor": [
                    {
                        "id": "128795",
                        "friendlyname": "Yahoo",
                        "url": "http://www.yahoo.com/",
                        "type": "1",
                        "subtype": "",
                        "keywordtype": "0",
                        "keywordvalue": "",
						"httpusername": "",
						"httppassword": "",
                        "port": "",
                        "status": "2",
                        "alltimeuptimeratio": "99.98",
                        "customuptimeratio": "100.00",
                        "monitoralertcontact": [
                            {
                                "id": "4631",
                                "type": "2",
                                "value": "uptime@webresourcesdepot.com"
                            },
                            {
                                "id": "2420",
                                "type": "3",
                                "value": "umutm"
                            }
                        ],
                        "log": [
                            {
                                "type": "2",
                                "datetime": "09/25/2011 16:12:44",
                                "alertcontact": [
                                    {
                                        "type": "0",
                                        "value": "uptime@webresourcesdepot.com"
                                    },
                                    {
                                        "type": "3",
                                        "value": "umutm"
                                    }
                                ]
                            },
                            {
                                "type": "1",
                                "datetime": "09/25/2011 16:11:44",
                                "alertcontact": [
                                    {
                                        "type": "0",
                                        "value": "uptime@webresourcesdepot.com"
                                    },
                                    {
                                        "type": "3",
                                        "value": "umutm"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "id": "128796",
                        "friendlyname": "WebResourcesDepot",
                        "url": "http://www.webresourcesdepot.com/",
                        "type": "1",
                        "subtype": "",
                        "keywordtype": "0",
                        "keywordvalue": "",
						"httpusername": "",
						"httppassword": "",
                        "port": "",
                        "status": "2",
                        "alltimeuptimeratio": "99.94",
                        "customtimeuptimeratio": "89.51",
                        "monitoralertcontact": [
                            {
                                "id": "2420",
                                "type": "3",
                                "value": "umutm"
                            }
                        ],
                        "log": [
                            {
                                "type": "2",
                                "datetime": "08/30/2011 16:11:15",
                                "alertcontact": [
                                    {
                                        "type": "0",
                                        "value": "uptime@webresourcesdepot.com"
                                    },
                                    {
                                        "type": "3",
                                        "value": "umutm"
                                    }
                                ]
                            },
                            {
                                "type": "1",
                                "datetime": "08/30/2011 16:09:30",
                                "alertcontact": [
                                    {
                                        "type": "0",
                                        "value": "uptime@webresourcesdepot.com"
                                    },
                                    {
                                        "type": "3",
                                        "value": "umutm"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        })
    

newMonitor

New monitors of any type can be created using this method.

Parameters

• apiKey - required
• monitorFriendlyName - required
• monitorURL - required
• monitorType - required
• monitorSubType - optional (required for port monitoring)
• monitorPort - optional (required for port monitoring)
• monitorKeywordType - optional (required for keyword monitoring)
• monitorKeywordValue - optional (required for keyword monitoring)
• monitorHTTPUsername - optional
• monitorHTTPPassword - optional
• monitorAlertContacts - optional (the alert contacts to be notified when the monitor goes up/down.Multiple alertContactIDs can be sent like monitorAlertContacts=457-373-8956)

Example Request And Response

        jsonUptimeRobotApi({
            "stat": "ok",
            "monitor":{
                "id":"128798"
            }
        })
   

editMonitor

Monitors can be edited using this method.

Important: The type of a monitor can not be edited (like changing a HTTP monitor into a Port monitor). For such cases, deleting the monitor and re-creating a new one is adviced.

Parameters

• apiKey - required
• monitorID - required
• monitorFriendlyName -optional
• monitorURL -optional
• monitorType -optional
• monitorSubType -optional (used only for port monitoring)
• monitorPort -optional (used onlyfor port monitoring)
• monitorKeywordType - optional (used only for keyword monitoring)
• monitorKeywordValue - optional (used only for keyword monitoring)
• monitorHTTPUsername - optional
• monitorHTTPPasswırd - optional
• monitorAlertContacts - optional (the alert contacts to be notified when the monitor goes up/down.Multiple alertContactIDs can be sent like monitorAlertContacts=457-373-8956)

Example Request And Response

        jsonUptimeRobotApi({
            "stat": "ok",
            "monitor":{
                "id":"128798"
            }
        })
   

deleteMonitor

Monitors can be deleted using this method.

Parameters

• apiKey - required
• monitorID - required

Example Request And Response

        jsonUptimeRobotApi({
            "stat": "ok",
            "monitor":{
                "id":"128798"
            }
        })
   

getAlertContacts

The list of alert contacts can be called with this method.

Parameters

• apiKey - required
• alertcontacts - optional (if not used, will return all alert contacts in an account. Else, it is possible to define any number of alert contacts with their IDs like: alertcontacts=236-1782-4790)

Example Request And Response

        jsonUptimeRobotApi({
            "stat": "ok",
            "alertcontacts": {
                "alertcontact": [
                    {
                        "id": "236",
                        "value": "uptime@webresourcesdepot.com",
                        "type": "2",
                        "status": "2"
                    }
                ]
            }
        })
   

newAlertContact

New alert contacts of any type (mobile/SMS alert contacts are not supported yet) can be created using this method.

The alert contacts created using the API are validated with the same way as they were created from uptimerobot.com (activation link for e-mails, tc.).

Parameters

• apiKey - required
• alertContactType - required
• alertContactValue - required

Example Request And Response

        jsonUptimeRobotApi({
            "stat": "ok",
            "alertcontact": {
                "id": "4561",
                "status": "0"
            }
        })
   

deleteAlertContact

Alert contacts can be deleted using this method.

Parameters

• apiKey - required
• alertContactID - required

Example Request And Response

        jsonUptimeRobotApi({
            "stat": "ok",
            "alertcontact": {
                "id": "236"
            }
        })
   

Parameters

Error Messages

Errors are displayed as:

jsonUptimeRobotApi({
	"stat": "fail",
	"id":"101",
	"message":"apiKey is wrong"
})

Example PHP Code

For a quick start, here is a simple PHP code to retrieve the alltimeuptimeratio of a desired monitor:

<?php
/*Note: You'll need the ID of the monitor. For that, simply go to "http://api.uptimerobot.com/getMonitors?apiKey=yourApiKey" and get the ID of the monitor to be queried.*/
/*And, this code requires PHP 5+ or PHP 4 with SimpleXML enabled.*/

/*Variables - Start*/
$apiKey		= "yourApiKey"; /*replace with your apiKey*/
$monitorID	= 1111111; /*replace with your monitorID*/
$url 	= "http://api.uptimerobot.com/getMonitors?apiKey=" . $apiKey . "&monitors=" . $monitorID . "&format=xml";
/*Variables - End*/

/*Curl Request - Start*/
$c = curl_init($url);
curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
$responseXML = curl_exec($c);
curl_close($c);
/*Curl Request - End*/

/*XML Parsing - Start*/
$xml = simplexml_load_string($responseXML);

foreach($xml->monitor as $monitor) {
	echo $monitor['alltimeuptimeratio'];
}
/*XML Parsing - End*/
?>
      

Unofficial API Resources

Here is a list of API-related resources created by Uptime Robot users:

• PHP wrapper for Uptime Robot API (by @CodingOurWeb)
• .NET wrapper for Uptime Robot API (by @cmaneu)
• Classic ASP example for listing monitors (.zip) (by @coax)
• WordPress Dashboard Widget For Uptime Robot (by @CreativeBoulder & @CodeClarity)
• Android App For Uptime Robot (.apk file) (by @and_n0b0dy

Tighter Integration For Apps & Services

Do you have a web application/service with lots of users and websites to monitor? Do you need to integrate with Uptime Robot tighter (like creating users)? If so, please feel free to contact us from support(a-t)uptimerobot.com.