Give Feedback

cdn_endpoints

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

Synopsis

Manage CDN endpoints: create, update, delete, purge cache. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/cdn_create_endpoint.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`certificate_id` str		The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided.
`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.
`custom_domain` str		The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint.
`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.
`origin` str / required		The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space.
`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`
`ttl` int	Choices: `60` `600` `3600` (default) `86400` `604800`	The amount of time the content is cached by the CDN’s edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded.

Examples

- name: Create DigitalOcean CDN endpoint
  digitalocean.cloud.cdn_endpoints:
    token: "{{ token }}"
    origin: ansible-gh-ci-space-0.nyc3.digitaloceanspaces.com

Return Values

Key Returned Description

Key	Returned	Description
`endpoint` dict	always	DigitalOcean CDN endpoint. Sample: `{ "created_at": "2022-12-01T15:05:42Z", "endpoint": "ansible-gh-ci-space-0.nyc3.cdn.digitaloceanspaces.com", "id": "e6893ada-0fd7-48c2-88af-7c2784f404f2", "origin": "ansible-gh-ci-space-0.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: `[ "CDN endpoint not found", "CDN endpoint ansible-gh-ci-space-0.nyc3.digitaloceanspaces.com created", "CDN endpoint ansible-gh-ci-space-0.nyc3.digitaloceanspaces.com deleted", "CDN endpoint ansible-gh-ci-space-0.nyc3.digitaloceanspaces.com exists", "CDN endpoint ansible-gh-ci-space-0.nyc3.digitaloceanspaces.com updated", "CDN endpoint ansible-gh-ci-space-0.nyc3.digitaloceanspaces.com not updated" ]`

endpoint
dict

always

DigitalOcean CDN endpoint.
Sample:

{
  "created_at": "2022-12-01T15:05:42Z",
  "endpoint": "ansible-gh-ci-space-0.nyc3.cdn.digitaloceanspaces.com",
  "id": "e6893ada-0fd7-48c2-88af-7c2784f404f2",
  "origin": "ansible-gh-ci-space-0.nyc3.digitaloceanspaces.com",
  "ttl": 3600
}

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str