Give Feedback

uptime_alerts_info

Generated on 11 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

List all alerts for an uptime check. 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.
`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.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`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`

Examples

- name: Get uptime alerts
  digitalocean.cloud.uptime_alerts_info:
    token: "{{ token }}"
    check_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4

Return Values

Key Returned Description

Key	Returned	Description
`alerts` list	always	Uptime alerts. 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 alerts result information. Sample: `[ "Current uptime alerts", "No uptime alerts" ]`

alerts
list

always

Uptime alerts.
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