Updown APIs documentation

  1. The REST API ⇣ allows you to fetch your metrics and automate your checks administration. It's a simple HTTPS API returning JSON.
  2. The Push API (webhooks) ⇣ allows you to receive updates in real time when your checks goes up or down.

1. REST API

Authentication

All API calls requires authentication with an API key which can be passed either as an URL query parameter ?api-key= or as an HTTP header X-API-KEY: Sign in to see your API key.

We also offer read-only API key so you can build public integrations (like a truly custom status page or TV dashboard) directly in javascript without giving away your read/write access. This API key will only work with GET endpoints (green).

Client libraries

Here are some existing client libraries to work with the API:

API calls

2. Push API (webhooks)

Setup

To setup a new webhook, all you have to do it go the your settings page and add the desired endpoint to the list of webhook URLs. You can add many endpoints, they'll all receive the same events. updown.io will send a POST request to all these endpoints every time an event occurs. Even though you'll often get only one, events will always be sent in an array, as you may receive multiple events in the same request.

Your endpoint is supposed to respond with a HTTP 200 OK status (the body doesn't matter). Any other response will be considered an error and the webhook request will be retried up to 25 times. Keep in mind that other events might be added at any time and you will start receiving them, so make sure your code accepts and ignores unknown events.

Events