DigitalOcean.Domain (digital_ocean v0.5.0)

Summary

Functions

create(opts)

Create a domain.

delete(domain_name)

Delete a domain.

get(domain_name)

Retrieve details about a specific domain.

list(opts \\ [])

Retrieve a list of domains.

Functions

create(opts)

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

Create a domain.

Examples

iex> DigitalOcean.Domain.create(
...>   name: "example.com",
...>   ip_address: "1.2.3.4"
...> ) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

delete(domain_name)

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

Delete a domain.

Examples

iex> DigitalOcean.Domain.delete("example.com") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

get(domain_name)

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

Retrieve details about a specific domain.

Examples

iex> DigitalOcean.Domain.get("example.com") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

list(opts \\ [])

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

Retrieve a list of domains.

Examples

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