DigitalOcean.DomainRecord (digital_ocean v0.5.0)

Summary

Functions

create(domain_name, opts)

Create a domain record.

delete(domain_name, record_id)

Delete a domain record.

get(domain_name, record_id)

Retrieve details about a specific domain record.

list(domain_name, opts \\ [])

Retrieve a list of domain records.

update(domain_name, record_id, opts)

Update a domain record.

Functions

create(domain_name, opts)

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

Create a domain record.

Examples

iex> DigitalOcean.DomainRecord.create(
...>   type: "A",
...>   name: "www",
...>   data: "162.10.66.0",
...>   ttl: 1800
...> ) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

delete(domain_name, record_id)

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

Delete a domain record.

Examples

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

get(domain_name, record_id)

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

Retrieve details about a specific domain record.

Examples

iex> DigitalOcean.DomainRecord.get("example.com", 3352896) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Operation{} }

list(domain_name, opts \\ [])

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

Retrieve a list of domain records.

Examples

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

update(domain_name, record_id, opts)

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

Update a domain record.

Examples

iex> DigitalOcean.DomainRecord.update(
...>   "example.com",
...>   3352896,
...>   name: "blog"
...> ) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }