Sign in
DigitalOcean-public.v2-new_Uptime

List All Alerts

To list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.

get/v2/uptime/checks/{check_id}/alerts

Path parameters

check_idstring uuid required

A unique identifier for a check.

Query parameters

per_pageinteger

Number of items returned per page

pageinteger

Which 'page' of paginated results to return.

Response

The response will be a JSON object with a key called alerts. This will be set to an array of objects, each of which will contain the standard attributes associated with an uptime alert.

Example response

{
  "alerts": [
    {
      "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
      "name": "Landing page degraded performance",
      "type": "latency",
      "threshold": 300,
      "comparison": "greater_than",
      "notifications": {
        "email": [
          "bob@example.com"
        ],
        "slack": [
          {
            "channel": "Production Alerts",
            "url": "https://hooks.slack.com/services/T1234567/AAAAAAAA/ZZZZZZ"
          }
        ]
      },
      "period": "2m"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  },
  "meta": {
    "total": 1
  }
}

Changes

Changed in 4 of the 8 revisions of this API.14