Sign in

v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_Uptime

Create a New Alert

To create an Uptime alert, send a POST request to /v2/uptime/checks/$CHECK_ID/alerts specifying the attributes in the table below in the JSON body.

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

Path parameters

check_idstring uuid required

A unique identifier for a check.

Request body

idstring uuid

A unique ID that can be used to identify and reference the alert.

namestring

A human-friendly display name.

type'latency' | 'down' | 'down_global' | 'ssl_expiry'

The type of alert.

thresholdinteger

The threshold at which the alert will enter a trigger state. The specific threshold is dependent on the alert type.

comparison'greater_than' | 'less_than'

The comparison operator used against the alert's threshold.

period'2m' | '3m' | '5m' | '10m' | '15m' | '30m' | '1h'

Period of time the threshold must be exceeded to trigger the alert.

Example request

{
  "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"
}

Response

The response will be a JSON object with a key called alert. The value of this will be an object that contains the standard attributes associated with an uptime alert.

Example response

{
  "alert": {
    "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"
  }
}