Cloudflare.DnsRecord (Cloudflare v0.2.0) View Source

DNS Records for a Zone

Documentation for Cloudflare DNS records

List DNS Records

GET List, search, sort, and filter a zones' DNS records.

GET zones/:zone_identifier/dns_records

Permission needed: #dns_records:read

Available in:

FREE
PRO
BUSINESS
ENTERPRISE

Create DNS Record

POST Create a new DNS record for a zone. See the record object definitions for required attributes for each record type

POST zones/:zone_identifier/dns_records

Permission needed: #dns_records:edit

Available in:

FREE
PRO
BUSINESS
ENTERPRISE

DNS Record Details

GET

GET zones/:zone_identifier/dns_records/:identifier

Permission needed: #dns_records:read

Available in:

FREE
PRO
BUSINESS
ENTERPRISE

Update DNS Record

PUT

PUT zones/:zone_identifier/dns_records/:identifier

Permission needed: #dns_records:edit

Available in:

FREE
PRO
BUSINESS
ENTERPRISE

Patch DNS Record

PATCH

PATCH zones/:zone_identifier/dns_records/:identifier

Permission needed: #dns_records:edit

Available in:

FREE
PRO
BUSINESS
ENTERPRISE

Delete DNS Record

DELETE

DELETE zones/:zone_identifier/dns_records/:identifier

Permission needed: #dns_records:edit

Available in:

FREE
PRO
BUSINESS
ENTERPRISE

Import DNS Records

POST You can upload your BIND config through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present.

POST zones/:zone_identifier/dns_records/import

Permission needed: #dns_records:edit

Available in:

FREE
PRO
BUSINESS
ENTERPRISE

Export DNS Records

GET You can export your BIND config through this endpoint.

GET zones/:zone_identifier/dns_records/export

Permission needed: #dns_records:read

Available in:

FREE
PRO
BUSINESS
ENTERPRISE

Link to this section Summary

Functions

client(opts \\ [])

create(body, opts \\ [])

create!(body, opts \\ [])

delete(id, opts \\ [])

delete!(id, opts \\ [])

export(opts \\ [])

import(data, opts \\ [])

index(opts \\ [])

index!(opts \\ [])

path_for(id, opts \\ [])

show(id, opts \\ [])

show!(id, opts \\ [])

update(id, body, opts \\ [])

update!(id, body, opts \\ [])

Link to this section Functions

client(opts \\ [])

Specs

client(Restlax.Resource.action_options()) :: module()

create(body, opts \\ [])

Specs

create(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  Tesla.Env.result()

create!(body, opts \\ [])

Specs

create!(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  Tesla.Env.t() | no_return()

delete(id, opts \\ [])

Specs

delete(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.result()

delete!(id, opts \\ [])

Specs

delete!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.t() | no_return()

export(opts \\ [])

import(data, opts \\ [])

index(opts \\ [])

Specs

index(opts :: Restlax.Resource.action_options()) :: Tesla.Env.result()

index!(opts \\ [])

Specs

index!(opts :: Restlax.Resource.action_options()) :: Tesla.Env.t() | no_return()

path_for(id, opts \\ [])

Specs

path_for(term(), [{:action, String.t()}]) :: String.t()

show(id, opts \\ [])

Specs

show(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.result()

show!(id, opts \\ [])

Specs

show!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.t() | no_return()

update(id, body, opts \\ [])

Specs

update(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: Tesla.Env.result()

update!(id, body, opts \\ [])

Specs

update!(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: Tesla.Env.t() | no_return()