updown.io API

https://updown.io/api
Admin
updown.io API is a REST API service that allows users to fetch monitoring metrics, automate checks...
Tokens:12,965
Snippets:36
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Webhook Setup and Handling

Source: https://updown.io/api/index

Details on setting up webhooks via the settings page or REST API, and how the system sends events. Endpoints must respond with 200 OK and handle events robustly.

```APIDOC
Push API (Webhooks):
  Setup: Add desired endpoint URLs in the settings page or use the `/api/recipients` endpoint.
  Event Delivery:
    - Events are sent via POST requests to configured endpoints.
    - Events are always sent in an array, even if only one event is present.
    - Endpoint Response: Must respond with HTTP 200 OK. Other responses are treated as errors.
    - Retries: Failed requests are retried up to 25 times over several days.
    - Failure Warnings: Email notifications are sent for consistent failures (10, 100, 900 requests).
    - Endpoint Removal: Automatically removed after 1000 failed deliveries.
  Forward Compatibility:
    - Endpoints should accept and ignore unknown events.
  Event Structure:
    - All events include a `description` attribute with a plain-text summary.
```

--------------------------------

### Update Check Example

Source: https://updown.io/api/index

Example of how to update a check using a curl command, specifying the URL and API key.

```bash
curl -X PUT -d 'url=:url' https://updown.io/api/checks/:token?api-key=:apikey
```

--------------------------------

### Updated Check Output

Source: https://updown.io/api/index

Example JSON output representing an updated check, showing various properties like token, URL, status, and configuration.

```json
{
  "token": "ra6y",
  "url": "http://google.com",
  "type": "http",
  "alias": null,
  "last_status": null,
  "uptime": 100.0,
  "down": false,
  "down_since": null,
  "up_since": null,
  "error": null,
  "period": 60,
  "apdex_t": 0.5,
  "string_match": "",
  "enabled": true,
  "published": false,
  "disabled_locations": [],
  "recipients": ["email:1800216481", "slack:2734790322"],
  "last_check_at": null,
  "next_check_at": "2023-12-28T11:14:27Z",
  "created_at": "2023-12-28T11:13:27Z",
  "mute_until": null,
  "favicon_url": null,
  "custom_headers": {},
  "http_verb": "GET/HEAD",
  "http_body": ""
}
```

--------------------------------

### Get IPv6 Addresses using dig

Source: https://updown.io/api/index

Retrieves the IPv6 addresses for updown.io monitoring nodes using the `dig` command. This is useful for firewall whitelisting. Requires `dig` to be installed.

```shell
dig +short AAAA ips.updown.io
```

--------------------------------

### Get IPv4 Addresses using dig

Source: https://updown.io/api/index

Retrieves the IPv4 addresses for updown.io monitoring nodes using the `dig` command. This is useful for firewall whitelisting. Requires `dig` to be installed.

```shell
dig +short A ips.updown.io
```

--------------------------------

### updown.io API Authentication and Compression

Source: https://updown.io/api/index

Details on how to authenticate API requests using an API key (as a query parameter or header) and how to enable gzip compression for improved performance. Read-only keys are also mentioned for public integrations.

```APIDOC
Authentication:
  - API Key can be passed as URL query parameter: `?api-key=`
  - API Key can be passed as HTTP header: `X-API-KEY:`
  - Read-only API keys are available for public integrations (GET endpoints only).

Compression:
  - Supports gzip compression via `Accept-Encoding: gzip` HTTP header.
  - Curl example: `--compressed` option.
```

--------------------------------

### updown.io API Client Libraries

Source: https://updown.io/api/index

A list of community-developed client libraries and tools for interacting with the updown.io API across various programming languages. These libraries simplify API integration.

```Ruby
askehansen/updown-ruby (also offers a CLI)
```

```Python
brandonhamilton/updown-python or decryptus/updownio
```

```Node.js
woubuc/node-updown or ffflorian/updown.io
```

```Go
AntoineAugusti/updown
```

```PHP
gbradley/updown or fakiolinho/updown-php
```

```Elixir
milok7/updown-elixir
```

```Rust
wmeph/updown-rust (also offers a CLI)
```

```Raku
lizmat/Updown
```

```Java
SIT-DE-DEVELOPERS/UpDownCheck (tool to execute commands when sites are down)
```

```.NET
strvmarv/updown-dotnet (NuGet package: UpdownDotnet)
```

--------------------------------

### List Updown.io Status Pages

Source: https://updown.io/api/index

Retrieves a list of all status pages associated with your account. Each status page entry includes its token, URL, name, description, visibility settings, and associated checks.

```APIDOC
GET /api/status_pages

Description:
  Lists all status pages created for your account.

Parameters:
  api-key: Your Updown.io API key.

Example:
  curl https://updown.io/api/status_pages?api-key=:apikey

Output:
  An array of hashes, each hash representing a status page.
  [
    {
      "token": "3ji4k",
      "url": "https://updown.io/p/3ji4k",
      "name": "Sample status page ✨",
      "description": "This is a demonstration status page from https://updown.io.\nYou can create and customize this kind of page for your own services.",
      "visibility": "public",
      "access_key": null,
      "checks": ["ngg8", "dmbe", "9e75", "l7ua", "6xjq", "wxax", "afha", "5yfe", "4osx", "1mjm", "sh6n", "5njh", "b1uc"]
    }
  ]
```

```shell
curl https://updown.io/api/status_pages?api-key=:apikey
```

--------------------------------

### List All Nodes API

Source: https://updown.io/api/index

Retrieves a list of all Updown.io servers, including both monitoring and webhook nodes. Returns detailed information for each node.

```APIDOC
GET /api/nodes
  Lists all Updown.io servers (monitoring & webhooks).

  Parameters:
    none

  Example:
    curl https://updown.io/api/nodes

  Output:
    A hash where keys are node names and values contain IP addresses, location, and coordinates.
    {
      "tok": {
        "ip": "45.76.104.117",
        "ip6": "2001:19f0:7001:45a::1",
        "city": "Tokyo",
        "country": "Japan",
        "country_code": "jp",
        "lat": 35.5833,
        "lng": 139.7483
      }
    }
```

--------------------------------

### Add Updown.io Status Page

Source: https://updown.io/api/index

Creates a new status page. You can specify which checks to include, the page's name, description, and visibility level (public, protected, private). Protected pages require an access key.

```APIDOC
POST /api/status_pages

Description:
  Creates a new status page.

Parameters:
  api-key: Your Updown.io API key.
  checks: [array, required] List of check tokens to display on the page, order is respected. Ex: `checks[]=dmbe&checks[]=ngg8`.
  name: [string, optional] Name of the status page.
  description: [string, optional] Text displayed below the name, supports newlines and links.
  visibility: [string, optional, default='public'] Page visibility: 'public', 'protected', or 'private'.
  access_key: [string, optional] Access key for protected pages; defaults to a random string if unset.

Example:
  curl -X POST -d 'checks=:checks' https://updown.io/api/status_pages?api-key=:apikey

Output:
  A hash representing the newly created status page.
  {
    "token": "j4uqk",
    "url": "https://updown.io/p/j4uqk",
    "name": "My Page",
    "description": null,
    "visibility": "private",
    "access_key": null,
    "checks": [
      "dmbe",
      "ngg8"
    ]
  }
```

```shell
curl -X POST -d 'checks=:checks' https://updown.io/api/status_pages?api-key=:apikey
```

--------------------------------

### Updown.io API: Check Management (List & Details)

Source: https://updown.io/api/index

Endpoints for listing all checks and retrieving detailed information for a specific check. The list endpoint provides an overview, while the detail endpoint offers comprehensive data for a single check, optionally including performance metrics.

```APIDOC
GET /api/checks
  Description: Lists all checks associated with the API key. URLs returned do not include basic auth credentials for security reasons.
  Parameters:
    none
  Notes:
    URLs returned here will not include basic auth credentials if any, for security reasons. So be careful when re-using this URL for update at the risk of erasing the credentials.
  Example:
    curl https://updown.io/api/checks?api-key=:apikey
  Output:
    An array of hashes, each hash representing a check.
    [
      {
        "token": "ngg8",
        "url": "https://updown.io",
        "type": "https",
        "alias": "",
        "last_status": 200,
        "uptime": 100,
        "down": false,
        "down_since": null,
        "up_since": "2023-12-23T09:06:51Z",
        "error": null,
        "period": 15,
        "apdex_t": 0.5,
        "string_match": "",
        "enabled": true,
        "published": true,
        "disabled_locations": [],
        "recipients": ["email:1246848337", "sms:231178295"],
        "last_check_at": "2021-12-17T05:00:01Z",
        "next_check_at": "2021-12-17T05:00:16Z",
        "created_at": "2012-09-22T13:29:44Z",
        "mute_until": null,
        "favicon_url": "https://updown.io/favicon.png",
        "custom_headers": {},
        "http_verb": "GET/HEAD",
        "http_body": "",
        "ssl": {
          "tested_at": "2021-12-17T04:58:04Z",
          "expires_at": "2022-02-21T15:57:36Z",
          "valid": true,
          "error": null
        }
      }
    ]

GET /api/checks/:token
  Description: Shows a single check's details. Optionally include performance metrics for the last hour.
  Parameters:
    token (string, required): The unique token of the check.
    metrics (boolean, optional): Include performance metrics (last hour only).
  Notes:
    URLs returned here will not include basic auth credentials if any, for security reasons. So be careful when re-using this URL for update at the risk of erasing the credentials.
  Example:
    curl https://updown.io/api/checks/:token?api-key=:apikey
  Output:
    A hash representing the check.
    {
      "token": "ngg8",
      "url": "https://updown.io",
      "type": "https",
      "alias": "",
      "last_status": 200,
      "uptime": 100,
      "down": false,
      "down_since": null,
      "up_since": "2023-12-23T09:06:51Z",
      "error": null,
      "period": 15,
      "apdex_t": 0.5,
      "string_match": "",
      "enabled": true,
      "published": true,
      "disabled_locations": [],
      "recipients": ["email:1246848337", "sms:231178295"],
      "last_check_at": "2021-12-17T05:00:01Z",
      "next_check_at": "2021-12-17T05:00:16Z",
      "created_at": "2012-09-22T13:29:44Z",
      "mute_until": null,
      "favicon_url": "https://updown.io/favicon.png",
      "custom_headers": {},
      "http_verb": "GET/HEAD",
      "http_body": "",
      "ssl": {
        "tested_at": "2021-12-17T04:58:04Z",
        "expires_at": "2022-02-21T15:57:36Z",
        "valid": true,
        "error": null
      }
    }
```

--------------------------------

### Updown.io API: Check Management

Source: https://updown.io/api/index

Provides endpoints for managing uptime checks, including creating new checks and updating existing ones. Parameters define check behavior, alerting, and monitoring preferences.

```APIDOC
POST /api/checks – Add a new check.

Parameters:
  url *[string]*: The URL to monitor (required for non-pulse checks).
  type *[string]*: Check type (https, http, icmp, pulse, tcp, tcps). Inferred from URL scheme by default.
  period *[integer] = 60*: Monitoring interval in seconds (e.g., 15, 30, 60, 120, 300, 600, 1800, 3600). Pulse checks support up to 1 month.
  apdex_t *[float] = 0.5*: APDEX threshold in seconds (e.g., 0.125, 0.25, 0.5, 1.0, 2.0, 4.0, 8.0).
  enabled *[boolean] = true*: Whether the check is active.
  published *[boolean] = false*: Whether the status page is public.
  alias *[string]*: A human-readable name for the check.
  string_match *[string]*: String to search for in the page content.
  mute_until *[string]*: Mute notifications until a specific time, 'recovery', or 'forever'.
  http_verb *[string]*: HTTP method for requests (GET/HEAD, POST, PUT, PATCH, DELETE, OPTIONS).
  http_body *[string]*: HTTP request body.
  disabled_locations *[array]*: Array of abbreviated location names to disable monitoring from (e.g., ["lan", "mia"]).
  recipients *[array]*: Array of recipient IDs for alerts (e.g., ["email:12345", "sms:67890"]).
  custom_headers *[hash]*: Custom HTTP headers for requests (e.g., {"X-Api-Key": "xxxxxxxxx"}).

Example:
  curl -X POST -d 'url=:url' https://updown.io/api/checks?api-key=:apikey

Output:
  A hash representing the newly created check, including its token.
  {
    "token": "ra6y",
    "url": "http://google.com",
    "type": "http",
    "alias": null,
    "last_status": null,
    "uptime": 100.0,
    "down": false,
    "down_since": null,
    "up_since": null,
    "error": null,
    "period": 60,
    "apdex_t": 0.5,
    "string_match": "",
    "enabled": true,
    "published": false,
    "disabled_locations": [],
    "recipients": ["email:1800216481", "slack:2734790322"],
    "last_check_at": null,
    "next_check_at": "2023-12-28T11:14:27Z",
    "created_at": "2023-12-28T11:13:27Z",
    "mute_until": null,
    "favicon_url": null,
    "custom_headers": {},
    "http_verb": "GET/HEAD",
    "http_body": ""
  }

PUT /api/checks/:token – Update a check.

Parameters:
  token *[string]*: The unique token of the check to update (required).
  url *[string]*: The new URL to monitor.
  period *[integer]*: New monitoring interval in seconds.
  apdex_t *[float]*: New APDEX threshold in seconds.
  enabled *[boolean]*: Update check status (true/false).
  published *[boolean]*: Update status page visibility (true/false).
  alias *[string]*: New human-readable name.
  string_match *[string]*: New string to search for in page content.
  mute_until *[string]*: New mute notification setting.
  http_verb *[string]*: New HTTP method for requests.
  http_body *[string]*: New HTTP request body.
  disabled_locations *[array]*: New array of disabled monitoring locations.

Note: Not all parameters are listed for PUT, only those that differ or are commonly updated. The API supports updating any of the parameters defined for POST.
```

--------------------------------

### List All IPv6 Node IPs API

Source: https://updown.io/api/index

Fetches a list of all IPv6 addresses used by Updown.io servers. Supports JSON or plain text output formats.

```APIDOC
GET /api/nodes/ipv6*(.format)*
  Lists all Updown.io servers IPv6 addresses.

  Parameters:
    format (string, optional, default: json): Response format. Supports 'json' or 'txt'. Can be specified as URL extension, query param, or Accept header.

  Example:
    curl https://updown.io/api/nodes/ipv6

  Output:
    An array of strings representing IPv6 addresses.
    [
      "2001:19f0:6001:2c6::1",
      "2001:19f0:9002:11a::1",
      "2607:5300:60:4c2f::1",
      "2001:41d0:2:85af::1",
      "2001:19f0:6c01:145::1",
      "2a01:4f9:c010:d5f9::1",
      "2001:19f0:4400:402e::1",
      "2001:19f0:7001:45a::1",
      "2001:19f0:5801:1d8::1",
      "2a01:4f8:141:441a::2"
    ]
```

--------------------------------

### List All Node IPs API

Source: https://updown.io/api/index

Fetches a list of all IP addresses used by Updown.io servers. Supports JSON or plain text output formats.

```APIDOC
GET /api/nodes/ips*(.format)*
  Lists all Updown.io servers IP addresses.

  Parameters:
    format (string, optional, default: json): Response format. Supports 'json' or 'txt'. Can be specified as URL extension, query param, or Accept header.

  Example:
    curl https://updown.io/api/nodes/ips

  Output (JSON):
    An array of strings representing IP addresses.
    [
      "2001:19f0:6001:2c6::1",
      "45.32.74.41",
      ...
    ]

  Output (TXT):
    Plain text, one IP per line.
    45.32.74.41
    104.238.136.194
    ...
```

--------------------------------

### updown.io REST API Endpoints

Source: https://updown.io/api/index

Lists the available endpoints for the updown.io REST API, used for managing checks, downtimes, metrics, nodes, recipients, and status pages. Authentication is required via API key.

```APIDOC
GET /api/checks
  - Lists all your checks.

GET /api/checks/:token
  - Shows a single check.

GET /api/checks/:token/downtimes
  - Gets all the downtimes of a check.

GET /api/checks/:token/metrics
  - Gets detailed metrics about the check.

POST /api/checks
  - Adds a new check.

PUT /api/checks/:token
  - Updates a check.

DELETE /api/checks/:token
  - Deletes a check.

GET /api/nodes
  - Lists all updown.io servers (monitoring & webhooks).

GET /api/nodes/ips
  - Lists all updown.io servers IP addresses.

GET /api/nodes/ipv4
  - Lists all updown.io servers IPv4 addresses.

GET /api/nodes/ipv6
  - Lists all updown.io servers IPv6 addresses.

GET /api/recipients
  - Lists all possible alert recipients/channels on your account.

POST /api/recipients
  - Adds a new recipient.

DELETE /api/recipients/:id
  - Deletes a recipient.

GET /api/status_pages
  - Lists all your status pages.

POST /api/status_pages
  - Adds a new status page.

PUT /api/status_pages/:token
  - Updates a status page.

DELETE /api/status_pages/:token
  - Deletes a status page.
```

--------------------------------

### List All IPv4 Node IPs API

Source: https://updown.io/api/index

Retrieves a list of all IPv4 addresses used by Updown.io servers. Output can be in JSON or plain text format.

```APIDOC
GET /api/nodes/ipv4*(.format)*
  Lists all Updown.io servers IPv4 addresses.

  Parameters:
    format (string, optional, default: json): Response format. Supports 'json' or 'txt'. Can be specified as URL extension, query param, or Accept header.

  Example:
    curl https://updown.io/api/nodes/ipv4

  Output (TXT):
    Plain text, one IP per line.
    45.32.74.41
    104.238.136.194
    192.99.37.47
    91.121.222.175
    104.238.159.87
    135.181.102.135
    45.32.107.181
    45.76.104.117
    45.63.29.207
    178.63.21.176
```

--------------------------------

### Accepted Time Formats (REST API)

Source: https://updown.io/api/index

Specifies the accepted formats for time values in REST API parameters. Timezones are optional and default to UTC if omitted. Ensure strings are URL encoded.

```APIDOC
Accepted Time Formats:
  - ISO8601: e.g., `2011-10-05T22:26:12-04:00`
  - RFC2822: e.g., `Wed, 05 Oct 2011 22:26:12 -0400`
  - Date only: e.g., `2010-10-31` (maps to midnight UTC)
  Note: Other formats may work. Omitting timezone defaults to UTC. URL encode parameters like `%2B` for `+`.
```

--------------------------------

### Retrieve Metrics with Aggregation

Source: https://updown.io/api/index

Fetches metrics data for a check. Metrics are aggregated by day after 2 days and by month after 40 days. The 'group' parameter influences the output structure.

```curl
curl https://updown.io/api/checks/:token/metrics?api-key=:apikey
```

```json
{
  "uptime": 99.999,
  "apdex": 0.999,
  "requests": {
    "samples": 87441,
    "failures": 2,
    "satisfied": 87357,
    "tolerated": 77,
    "by_response_time": {
      "under125": 70521,
      "under250": 71126,
      "under500": 87357,
      "under1000": 87422,
      "under2000": 87434,
      "under4000": 87438
    }
  },
  "timings": {
    "redirect": 0,
    "namelookup": 9,
    "connection": 88,
    "handshake": 183,
    "response": 90,
    "total": 370
  }
}
```

--------------------------------

### Updown.io API: Check Metrics

Source: https://updown.io/api/index

Retrieves aggregated performance metrics for a specific check within a given time range. Data is aggregated hourly, and can be grouped by time or by host (location).

```APIDOC
GET /api/checks/:token/metrics
  Description: Gets detailed metrics about the check.
  Parameters:
    token (string, required): The check unique token.
    from (time, optional, default=1 month ago): Start time for metrics. Supported formats include RFC3339, Unix timestamps, and human-readable strings.
    to (time, optional, default=now): End time for metrics. Supported formats include RFC3339, Unix timestamps, and human-readable strings.
    group (symbol, optional): Group data by "time" (hourly aggregation) or "host" (location).
  Notes:
    Statistics are aggregated per hour. The time range needs to be at least one hour to get any data.
  Example:
    curl https://updown.io/api/checks/:token/metrics?api-key=:apikey&from=2024-09-01T00:00:00Z&to=2024-09-30T23:59:59Z&group=time
```

--------------------------------

### Update Check Parameters

Source: https://updown.io/api/index

Describes parameters for updating an existing check via the API. Includes options for disabling locations, setting recipients, and adding custom headers.

```APIDOC
Parameters for updating checks:

- disabled_locations: Array of abbreviated location names to disable monitoring from. Allowed values: ["lan", "mia", "bhs", "rbx", "fra", "hel", "sin", "tok", "syd"]. Example: `disabled_locations[]=lan&disabled_locations[]=syd`
- recipients: Array of recipient IDs for alerts. IDs can be obtained from the recipients API. Example: `recipients[]=email:12345&recipients[]=sms:67890`
- custom_headers: Hash of HTTP headers to include in Updown requests. Example: `custom_headers[X-Api-Key]=xxxxxxxxx`
```

--------------------------------

### Updown.io API: Downtime History

Source: https://updown.io/api/index

Retrieves a list of downtime events for a specific check. Results can be paginated and optionally include detailed request information for each downtime period.

```APIDOC
GET /api/checks/:token/downtimes
  Description: Gets all the downtimes of a check, ordered from newest to oldest.
  Parameters:
    token (string, required): The check unique token.
    page (integer, optional, default=1): The page to fetch (100 downtimes per page).
    results (boolean, optional): Include detailed results (last 5 requests before downtime and recovery). This can be huge so we recommend enabling gzip compression (`Accept-Encoding: gzip`).
  Example:
    curl https://updown.io/api/checks/:token/downtimes?api-key=:apikey
  Output:
    An array of hashes, ordered from newest downtimes to oldest.
    [
      {
        "id": "66f255685d3c15c3bbe8fd6e",
        "details_url": "https://updown.io/downtimes/66f255685d3c15c3bbe8fd6e",
        "error": "Connection timeout (10 seconds)",
        "started_at": "2024-09-24T05:59:32Z",
        "ended_at": "2024-09-24T08:06:08Z",
        "duration": 7596,
        "partial": false
      },
      {
        "id": "66f2541c4fe3629362cb5120",
        "details_url": "https://updown.io/downtimes/66f2541c4fe3629362cb5120",
        "error": "TLS handshake timeout (10 seconds)",
        "started_at": "2024-09-24T05:53:14Z",
        "ended_at": "2024-09-24T05:56:37Z",
        "duration": 203,
        "partial": false
      }
    ]
```

--------------------------------

### Update Status Page (REST API)

Source: https://updown.io/api/index

Updates an existing status page using its token. Requires an API key for authentication. The request body can include various page properties like checks.

```APIDOC
PUT /api/status_pages/:token
  Description: Updates a status page.
  Parameters:
    token*: The unique token of the status page to update.
    api-key: The access key for authentication.
    checks: The checks to associate with the status page (example implies this parameter).
  Example Request:
    curl -X PUT -d 'checks=:checks' https://updown.io/api/status_pages/:token?api-key=:apikey
  Example Output:
    {
      "token": "j4uqk",
      "url": "https://updown.io/p/j4uqk",
      "name": "My Page",
      "description": null,
      "visibility": "protected",
      "access_key": "8wFAy6pWkeVM3eca4TG71zN7N4tKcy",
      "checks": [
        "dmbe",
        "ngg8"
      ]
    }
```

--------------------------------

### List Updown.io Recipients

Source: https://updown.io/api/index

Retrieves a list of all configured recipients. Each recipient object includes its ID, type, name, and value. This is useful for auditing or managing existing notification channels.

```APIDOC
GET /api/recipients

Description:
  Lists all recipients configured for your Updown.io account.

Parameters:
  api-key: Your Updown.io API key.

Example:
  curl https://updown.io/api/recipients?api-key=:apikey

Output:
  An array of hashes, each hash representing one contact channel.
  [
    {
      "id": "email:3719031852",
      "type": "email",
      "name": "tech@example.com",
      "value": "Company <tech@example.com>"
    },
    {
      "id": "sms:231178295",
      "type": "sms",
      "name": "+33123456789",
      "value": "+33123456789"
    },
    {
      "id": "slack:2734790322",
      "type": "slack",
      "name": "mycompany#monitoring"
    },
    {
      "id": "telegram:4147979801",
      "type": "telegram",
      "name": "Adrien Rey-Jarthon"
    },
    {
      "id": "webhook:1159873859",
      "type": "webhook",
      "name": "My proxy",
      "value": "https://example.com/updown-endpoint"
    },
    {
      "id": "zapier:2082375816",
      "type": "zapier",
      "name": "Send alerts to Teams"
    }
  ]
```

```shell
curl https://updown.io/api/recipients?api-key=:apikey
```

--------------------------------

### Webhook Event: check.ssl_expiration

Source: https://updown.io/api/index

Notifies when an SSL certificate is approaching its expiration date. This event includes details about the check configuration and the SSL certificate's expiration status, such as days remaining before expiration.

```JSON
[{
  "event": "check.ssl_expiration",
  "time": "2025-07-28T12:00:40Z",
  "description": "The SSL certificate served by updown.io will expire in 7 days",
  "check": {
    "token": "xyz0",
    "url": "https://updown.io",
    "type": "https",
    "alias": null,
    "uptime": 100,
    "down": false,
    "down_since": null,
    "up_since": "2025-06-28T12:00:40Z",
    "error": null,
    "period": 30,
    "string_match": "",
    "enabled": true,
    "published": true,
    "recipients": [],
    "last_check_at": "2025-07-28T12:00:25Z",
    "next_check_at": "2025-07-28T12:00:55Z",
    "created_at": null,
    "mute_until": null,
    "last_status": 200,
    "apdex_t": 0.25,
    "disabled_locations": [],
    "custom_headers": {},
    "favicon_url": "https://updown.io/favicon.png",
    "http_verb": "GET/HEAD",
    "http_body": ""
  },
  "ssl": {
    "cert": {
      "subject": "updown.io",
      "issuer": "Let's Encrypt Authority X3 (Let's Encrypt)",
      "from": "2018-09-08T21:00:18Z",
      "to": "2018-12-07T21:00:18Z",
      "algorithm": "SHA-256 with RSA encryption"
    },
    "days_before_expiration": 7
  }
}]
```

--------------------------------

### List Recipients API

Source: https://updown.io/api/index

Retrieves a list of all possible alert recipients or channels configured on the account. The 'id' attribute is crucial for selecting recipients in check configurations.

```APIDOC
GET /api/recipients
  Lists all the possible alert recipients/channels on your account.

  Parameters:
    none

  Notes:
    The "id" attribute is the one you need to select recipients in the checks API.
```

--------------------------------

### Webhook Event: check.ssl_renewed

Source: https://updown.io/api/index

Notifies when an SSL certificate has been successfully renewed, typically as a recovery from an expiration warning. This event provides details on both the newly issued certificate and the previous one.

```JSON
[{
  "event": "check.ssl_renewed",
  "time": "2025-07-28T12:00:40Z",
  "description": "The SSL certificate served by updown.io was renewed",
  "check": {
    "token": "xyz0",
    "url": "https://updown.io",
    "type": "https",
    "alias": null,
    "uptime": 100,
    "down": false,
    "down_since": null,
    "up_since": "2025-06-28T12:00:40Z",
    "error": null,
    "period": 30,
    "string_match": "",
    "enabled": true,
    "published": true,
    "recipients": [],
    "last_check_at": "2025-07-28T12:00:25Z",
    "next_check_at": "2025-07-28T12:00:55Z",
    "created_at": null,
    "mute_until": null,
    "last_status": 200,
    "apdex_t": 0.25,
    "disabled_locations": [],
    "custom_headers": {},
    "favicon_url": "https://updown.io/favicon.png",
    "http_verb": "GET/HEAD",
    "http_body": ""
  },
  "ssl": {
    "new_cert": {
      "subject": "updown.io",
      "issuer": "Let's Encrypt Authority X3 (Let's Encrypt)",
      "from": "2018-09-08T21:00:18Z",
      "to": "2018-12-07T21:00:18Z",
      "algorithm": "SHA-256 with RSA encryption"
    },
    "old_cert": {
      "subject": "updown.io",
      "issuer": "Let's Encrypt Authority X3 (Let's Encrypt)",
      "from": "2018-09-08T21:00:18Z",
      "to": "2018-12-07T21:00:18Z",
      "algorithm": "SHA-256 with RSA encryption"
    }
  }
}]
```

--------------------------------

### Delete Status Page (REST API)

Source: https://updown.io/api/index

Deletes a status page identified by its token. Authentication is required via an API key.

```APIDOC
DELETE /api/status_pages/:token
  Description: Deletes a status page.
  Parameters:
    token*: The unique token of the status page to delete.
    api-key: The access key for authentication.
  Example Request:
    curl -X DELETE https://updown.io/api/status_pages/:token?api-key=:apikey
  Example Output:
    {
      "deleted": true
    }
```

--------------------------------

### Update Updown.io Status Page

Source: https://updown.io/api/index

Modifies an existing status page identified by its token. You can update the list of checks, name, description, and visibility settings.

```APIDOC
PUT /api/status_pages/:token

Description:
  Updates an existing status page.

Parameters:
  api-key: Your Updown.io API key.
  token: [string, required] The unique token of the status page to update.
  checks: [array, optional] List of check tokens to show in the page. Order is respected. Ex: `checks[]=dmbe&checks[]=ngg8`.
  name: [string, optional] Name of the status page.
  description: [string, optional] Text displayed below the name, supports newlines and links.
  visibility: [string, optional] Page visibility: 'public', 'protected', or 'private'.
```

```shell
curl -X PUT -d 'name=New Name&checks[]=check1' https://updown.io/api/status_pages/:token?api-key=:apikey
```

--------------------------------

### Webhook Event: check.performance_drop

Source: https://updown.io/api/index

Triggers when a check's Apdex score drops significantly (e.g., more than 30%) below the average of the last five hours. This event includes the percentage drop and historical Apdex metrics for context.

```JSON
[{
  "event": "check.performance_drop",
  "time": "2025-07-28T12:00:40Z",
  "description": "Apdex of https://updown.io/ dropped 47%",
  "check": {
    "token": "xyz0",
    "url": "https://updown.io",
    "type": "https",
    "alias": null,
    "uptime": 100,
    "down": false,
    "down_since": null,
    "up_since": "2025-06-28T12:00:40Z",
    "error": null,
    "period": 30,
    "string_match": "",
    "enabled": true,
    "published": true,
    "recipients": [],
    "last_check_at": "2025-07-28T12:00:25Z",
    "next_check_at": "2025-07-28T12:00:55Z",
    "created_at": null,
    "mute_until": null,
    "last_status": 200,
    "apdex_t": 0.25,
    "disabled_locations": [],
    "custom_headers": {},
    "favicon_url": "https://updown.io/favicon.png",
    "http_verb": "GET/HEAD",
    "http_body": ""
  },
  "apdex_dropped": "47%",
  "last_metrics": {
    "2023-03-12T02:00:00Z": { "apdex": 0.975 },
    "2023-03-12T03:00:00Z": { "apdex": 1 },
    "2023-03-12T04:00:00Z": { "apdex": 0.98 },
    "2023-03-12T05:00:00Z": { "apdex": 1 },
    "2023-03-12T06:00:00Z": { "apdex": 1 },
    "2023-03-12T07:00:00Z": { "apdex": 0.51 }
  }
}]
```

--------------------------------

### Webhook: check.ssl_valid Event Payload (JSON)

Source: https://updown.io/api/index

This event is emitted when an SSL certificate for a previously invalid HTTPS check is now considered valid. The payload includes event timestamps, a description, and details about the check that has recovered.

```json
[{
  "event": "check.ssl_valid",
  "time": "2025-07-28T12:00:40Z",
  "description": "The SSL certificate served by updown.io is now valid",
  "check": {
    "token": "xyz0",
    "url": "https://updown.io",
    "type": "https",
    "alias": null,
    "uptime": 100,
    "down": false,
    "down_since": null,
    "up_since": "2025-06-28T12:00:40Z",
    "error": null,
    "period": 30,
    "string_match": "",
    "enabled": true,
    "published": true,
    "recipients": [],
    "last_check_at": "2025-07-28T12:00:25Z",
    "next_check_at": "2025-07-28T12:00:55Z",
    "created_at": null,
    "mute_until": null,
    "last_status": 200,
    "apdex_t": 0.25,
    "disabled_locations": [],
    "custom_headers": {},
    "favicon_url": "https://updown.io/favicon.png",
    "http_verb": "GET/HEAD",
    "http_body": ""
  }
}]
```
Tokens:
Raw