View Source Vercel.Dns (Vercel v0.1.2)

Link to this section Summary

Functions

Creates a DNS record for a domain.

Removes an existing DNS record from a domain name.

Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options.

Link to this section Functions

Link to this function

create(domain, params, opts \\ %{})

View Source
@spec create(String.t(), params, opts) :: {:ok, map()} | {:error, any()}
when params: %{type: String.t(), name: String.t(), value: String.t()},
     opts: %{optional(:teamId) => String.t()}

Creates a DNS record for a domain.

Link to this function

delete(domain, record_id, params \\ %{})

View Source
@spec delete(domain :: String.t(), record_id :: String.t(), params) ::
  {:ok, map()} | {:error, any()}
when params: %{optional(:teamId) => String.t()}

Removes an existing DNS record from a domain name.

Link to this function

list(domain, params \\ %{})

View Source
@spec list(String.t(), params) :: {:ok, map()} | {:error, any()}
when params: %{
       optional(:limit) => String.t(),
       optional(:since) => String.t(),
       optional(:teamId) => String.t(),
       optional(:until) => String.t()
     }

Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options.