DigitalOcean.CDNEndpoint (digital_ocean v0.5.0)

Summary

Functions

create(opts)

Create a CDN endpoint.

delete(endpoint_id)

Delete a CDN endpoint.

get(endpoint_id)

Retrieve details about a specific CDN endpoint.

list(opts \\ [])

Retrieve a list of CDN endpoints.

purge_cache(endpoint_id, opts)

Purge cached content from an CDN endpoint.

update(endpoint_id, opts \\ [])

Update a CDN endpoint.

Functions

create(opts)

@spec create(Keyword.t()) :: DigitalOcean.Operation.t()

Create a CDN endpoint.

Examples

iex> DigitalOcean.CDNEndpoint.create(
...>   origin: "static-images.nyc3.digitaloceanspaces.com",
...>   certificate_id: "892071a0-bb95-49bc-8021-3afd67a210bf",
...>   custom_domain: "static.example.com",
...>   ttl: 3600
...> ) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

delete(endpoint_id)

@spec delete(String.t()) :: DigitalOcean.Operation.t()

Delete a CDN endpoint.

Examples

iex> DigitalOcean.CDNEndpoint.delete("19f06b6a-3ace-4315-b086-499a0e521b76") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

get(endpoint_id)

@spec get(String.t()) :: DigitalOcean.Operation.t()

Retrieve details about a specific CDN endpoint.

Examples

iex> DigitalOcean.CDNEndpoint.get("19f06b6a-3ace-4315-b086-499a0e521b76") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

list(opts \\ [])

@spec list(Keyword.t()) :: DigitalOcean.Operation.t()

Retrieve a list of CDN endpoints.

Exampless

iex> DigitalOcean.CDNEndpoint.list() |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

purge_cache(endpoint_id, opts)

Purge cached content from an CDN endpoint.

Examples

iex> DigitalOcean.CDNEndpoint.purge_cache(
...>   "19f06b6a-3ace-4315-b086-499a0e521b76",
...>   files: ["*"]
...> ) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

update(endpoint_id, opts \\ [])

@spec update(String.t(), Keyword.t()) :: DigitalOcean.Operation.t()

Update a CDN endpoint.

Examples

iex> DigitalOcean.CDNEndpoint.update(
...>   "19f06b6a-3ace-4315-b086-499a0e521b76",
...>   ttl: 1800
...> ) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }