uptime_checks_info

Generated on 16 July 2024 from digitalocean.cloud version v0.6.0

Synopsis

Requirements

  • pydo >= 0.1.6
  • azure-core >= 1.26.1

Parameters

Parameter Choices Default Comments
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)
  • present
 present Only present is supported which will return the Uptime checks.
timeout
(int)		 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:

[
  {
    "enabled": true,
    "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
    "name": "Landing page check",
    "regions": [
      "us_east",
      "eu_west"
    ],
    "target": "https://www.landingpage.com",
    "type": "https"
  }
]
error
(dict)		 failure DigitalOcean API error.

Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}
msg
(str)		 always Uptime checks result information.

Sample:

[
  "Current Uptime checks",
  "No Uptime checks"
]
Control Panel Blog Pricing Careers Terms Privacy Status API Docs Tutorials Support