uptime_checks_info
Generated on 1 Jul 2025
from digitalocean.cloud
version
v1.2.1
Synopsis
List all of the Uptime checks on your account. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/uptime_list_checks.
Requirements
- pydo >= 0.1.6
- azure-core >= 1.26.1
Parameters
Parameter | Choices / Default | Description |
---|---|---|
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:
|
Only present is supported which will return the Uptime checks. |
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 checks
digitalocean.cloud.uptime_checks_info:
token: "{{ token }}"
Return Values
Key | Returned | Description |
---|---|---|
checks list |
always | Uptime checks. Sample:
|
error dict |
failure | DigitalOcean API error. Sample:
|
msg str |
always | Uptime checks result information. Sample:
|