Give Feedback

cdn_endpoints_info

Generated on 30 Jun 2025 from digitalocean.cloud version v1.2.1

Synopsis

List all of the CDN endpoints available on your account. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/cdn_list_endpoints.

Requirements

pydo >= 0.1.3
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: `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 CDN endpoints
  digitalocean.cloud.cdn_endpoints_info:
    token: "{{ token }}"

Return Values

Key Returned Description

Key	Returned	Description
`endpoints` list	always	CDN endpoints. Sample: `[ { "certificate_id": "892071a0-bb95-49bc-8021-3afd67a210bf", "created_at": "2018-07-19T15:04:16Z", "custom_domain": "static.example.com", "endpoint": "static-images.nyc3.cdn.digitaloceanspaces.com", "id": "19f06b6a-3ace-4315-b086-499a0e521b76", "origin": "static-images.nyc3.digitaloceanspaces.com", "ttl": 3600 } ]`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	CDN endpoints result information. Sample: `[ "Current CDN endpoints", "No CDN endpoints" ]`

endpoints
list

always

CDN endpoints.
Sample:

[
  {
    "certificate_id": "892071a0-bb95-49bc-8021-3afd67a210bf",
    "created_at": "2018-07-19T15:04:16Z",
    "custom_domain": "static.example.com",
    "endpoint": "static-images.nyc3.cdn.digitaloceanspaces.com",
    "id": "19f06b6a-3ace-4315-b086-499a0e521b76",
    "origin": "static-images.nyc3.digitaloceanspaces.com",
    "ttl": 3600
  }
]

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str