Give Feedback

uptime_alert

Generated on 3 Apr 2026 from digitalocean.cloud version v1.2.1

Copy page as Markdown View page as Markdown

Synopsis

Create or delete alerts for uptime checks. Alerts notify you when an uptime check fails or recovers. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Uptime.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`check_id` str / required		The unique identifier of the uptime check.
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`comparison` str	Choices: `greater_than` `less_than`	The comparison operator for the threshold.
`id` str		The unique identifier of the alert. Used for lookup when updating or deleting.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`name` str / required		The name of the alert.
`notifications` dict		Notification settings for the alert.
`period` str	Choices: `2m` `3m` `5m` `10m` `15m` `30m` `1h`	The period of time the threshold must be breached to trigger the alert.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`threshold` int		The threshold at which the alert triggers. For latency alerts, this is in milliseconds. For ssl_expiry alerts, this is in days.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`
`type` str	Choices: `latency` `down` `down_global` `ssl_expiry`	The type of alert.

Examples

- name: Create uptime alert
  digitalocean.cloud.uptime_alert:
    token: "{{ token }}"
    state: present
    check_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4
    name: high-latency-alert
    type: latency
    threshold: 500
    comparison: greater_than
    notifications:
      email:
        - [email protected]
    period: 5m

- name: Delete uptime alert
  digitalocean.cloud.uptime_alert:
    token: "{{ token }}"
    state: absent
    check_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4
    name: high-latency-alert

Return Values

Key Returned Description

Key	Returned	Description
`alert` dict	always	Uptime alert information. Sample: `{ "comparison": "greater_than", "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "high-latency-alert", "notifications": { "email": [ "[email protected]" ] }, "period": "5m", "threshold": 500, "type": "latency" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Uptime alert result information. Sample: `[ "Created uptime alert high-latency-alert", "Deleted uptime alert high-latency-alert", "Uptime alert high-latency-alert would be created", "Uptime alert high-latency-alert exists", "Uptime alert high-latency-alert does not exist" ]`

alert
dict

always

Uptime alert information.
Sample:

{
  "comparison": "greater_than",
  "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
  "name": "high-latency-alert",
  "notifications": {
    "email": [
      "[email protected]"
    ]
  },
  "period": "5m",
  "threshold": 500,
  "type": "latency"
}

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str