Cloudflare API | DNS › Records

post/zones/{zone_id}/dns_records

Create a new DNS record for a zone.

Notes:

A/AAAA records cannot exist on the same name as CNAME records.
NS records cannot exist on the same name as any other record type.
Domain names are always represented in Punycode, even if Unicode characters were used when creating the record.

Delete DNS Record -> Envelope<{ id }>

delete/zones/{zone_id}/dns_records/{dns_record_id}

Delete DNS Record

Update DNS Record -> Envelope<

patch/zones/{zone_id}/dns_records/{dns_record_id}

Update an existing DNS record.

Notes:

A/AAAA records cannot exist on the same name as CNAME records.
NS records cannot exist on the same name as any other record type.
Domain names are always represented in Punycode, even if Unicode characters were used when creating the record.

Export DNS Records -> string

get/zones/{zone_id}/dns_records/export

You can export your BIND config through this endpoint.

See the documentation for more information.

DNS Record Details -> Envelope<

get/zones/{zone_id}/dns_records/{dns_record_id}

DNS Record Details

Import DNS Records -> Envelope<{ recs_added, total_records_parsed }>

post/zones/{zone_id}/dns_records/import

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.

See the documentation for more information.

List DNS Records -> V4PagePaginationArray<

get/zones/{zone_id}/dns_records

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

Scan DNS Records -> Envelope<{ recs_added, total_records_parsed }>

post/zones/{zone_id}/dns_records/scan

Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example: X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example: X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

DNS Write

path Parameters

zone_id: string

(maxLength: 32)

Identifier

Body parameters

body: unknown

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: true

Whether the API call was successful

result: { recs_added, total_records_parsed }

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/dns_records/scan \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{}'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "recs_added": 5,
    "total_records_parsed": 5
  }
}

Overwrite DNS Record -> Envelope<

put/zones/{zone_id}/dns_records/{dns_record_id}

Overwrite an existing DNS record.

Notes:

A/AAAA records cannot exist on the same name as CNAME records.
NS records cannot exist on the same name as any other record type.
Domain names are always represented in Punycode, even if Unicode characters were used when creating the record.

Domain types

ARecord = { comment, content, name, 5 more... }

AAAARecord = { comment, content, name, 5 more... }

BatchPatch =

| 18 more...

BatchPut =

| 18 more...

CAARecord = { comment, content, data, 6 more... }

CERTRecord = { comment, content, data, 6 more... }

CNAMERecord = { comment, content, name, 5 more... }

DNSKEYRecord = { comment, content, data, 6 more... }

DSRecord = { comment, content, data, 6 more... }

HTTPSRecord = { comment, content, data, 6 more... }

LOCRecord = { comment, content, data, 6 more... }

MXRecord = { comment, content, name, 6 more... }

NAPTRRecord = { comment, content, data, 6 more... }

NSRecord = { comment, content, name, 5 more... }

PTRRecord = { comment, content, name, 5 more... }

Record =

| 18 more...

RecordResponse =

| 18 more...

RecordTags = string

Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)

SMIMEARecord = { comment, content, data, 6 more... }

SRVRecord = { comment, content, data, 6 more... }

SSHFPRecord = { comment, content, data, 6 more... }

SVCBRecord = { comment, content, data, 6 more... }

TLSARecord = { comment, content, data, 6 more... }

TTL = number | 1

Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.

TXTRecord = { comment, content, name, 5 more... }

URIRecord = { comment, content, data, 7 more... }

DNS

Settings

dns.settings

Domain types

DNSSetting = { flatten_all_cnames, foundation_dns, internal_dns, 5 more... }

DNS Settings

Account

dns.settings.account

Methods

Update DNS Settings -> Envelope<{ zone_defaults }>

patch/accounts/{account_id}/dns_settings

Update DNS settings for an account

Show DNS Settings -> Envelope<{ zone_defaults }>

get/accounts/{account_id}/dns_settings

Show DNS settings for an account

DNS Settings Account

Views

dns.settings.account.views

Methods

Create Internal DNS View -> Envelope<{ id, created_time, modified_time, 2 more... }>

post/accounts/{account_id}/dns_settings/views

Create Internal DNS View for an account

Delete Internal DNS View -> Envelope<{ id }>

delete/accounts/{account_id}/dns_settings/views/{view_id}

Delete an existing Internal DNS View

Update Internal DNS View -> Envelope<{ id, created_time, modified_time, 2 more... }>

patch/accounts/{account_id}/dns_settings/views/{view_id}

Update an existing Internal DNS View

DNS Internal View Details -> Envelope<{ id, created_time, modified_time, 2 more... }>

get/accounts/{account_id}/dns_settings/views/{view_id}

Get DNS Internal View

List Internal DNS Views -> V4PagePaginationArray<{ id, created_time, modified_time, 2 more... }>

get/accounts/{account_id}/dns_settings/views

List DNS Internal Views for an Account

DNS Settings

Zone

dns.settings.zone

Methods

Update DNS Settings -> Envelope<{ flatten_all_cnames, foundation_dns, internal_dns, 6 more... }>

patch/zones/{zone_id}/dns_settings

Update DNS settings for a zone

Show DNS Settings -> Envelope<{ flatten_all_cnames, foundation_dns, internal_dns, 6 more... }>

get/zones/{zone_id}/dns_settings

Show DNS settings for a zone

DNS

Zone Transfers

dns.zone_transfers

ACLs

dns.zone_transfers.acls

Methods

Create ACL -> Envelope<

post/accounts/{account_id}/secondary_dns/acls

Create ACL.

Delete ACL -> Envelope<{ id }>

delete/accounts/{account_id}/secondary_dns/acls/{acl_id}

Delete ACL.

ACL Details -> Envelope<

get/accounts/{account_id}/secondary_dns/acls/{acl_id}

Get ACL.

List ACLs -> SinglePage<

get/accounts/{account_id}/secondary_dns/acls

List ACLs.

Update ACL -> Envelope<

put/accounts/{account_id}/secondary_dns/acls/{acl_id}

Modify ACL.

Domain types

ACL = { id, ip_range, name }

Force AXFR

dns.zone_transfers.force_axfr

Methods

Force AXFR -> Envelope<

ForceAXFR

post/zones/{zone_id}/secondary_dns/force_axfr

Sends AXFR zone transfer request to primary nameserver(s).

Domain types

ForceAXFR = string

When force_axfr query parameter is set to true, the response is a simple string

Incoming

dns.zone_transfers.incoming

Methods

Create Secondary Zone Configuration -> Envelope<{ id, auto_refresh_seconds, checked_time, 5 more... }>

post/zones/{zone_id}/secondary_dns/incoming

Create secondary zone configuration for incoming zone transfers.

Delete Secondary Zone Configuration -> Envelope<{ id }>

delete/zones/{zone_id}/secondary_dns/incoming

Delete secondary zone configuration for incoming zone transfers.

Secondary Zone Configuration Details -> Envelope<{ id, auto_refresh_seconds, checked_time, 5 more... }>

get/zones/{zone_id}/secondary_dns/incoming

Get secondary zone configuration for incoming zone transfers.

Update Secondary Zone Configuration -> Envelope<{ id, auto_refresh_seconds, checked_time, 5 more... }>

put/zones/{zone_id}/secondary_dns/incoming

Update secondary zone configuration for incoming zone transfers.

Domain types

Incoming = { id, auto_refresh_seconds, checked_time, 5 more... }

DNS Zone Transfers Outgoing

Outgoing

dns.zone_transfers.outgoing

Methods

Create Primary Zone Configuration -> Envelope<{ id, checked_time, created_time, 4 more... }>

post/zones/{zone_id}/secondary_dns/outgoing

Create primary zone configuration for outgoing zone transfers.

Delete Primary Zone Configuration -> Envelope<{ id }>

delete/zones/{zone_id}/secondary_dns/outgoing

Delete primary zone configuration for outgoing zone transfers.

Disable Outgoing Zone Transfers -> Envelope<

DisableTransfer

post/zones/{zone_id}/secondary_dns/outgoing/disable

Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.

Enable Outgoing Zone Transfers -> Envelope<

EnableTransfer

post/zones/{zone_id}/secondary_dns/outgoing/enable

Enable outgoing zone transfers for primary zone.

Force DNS Notify -> Envelope<string>

post/zones/{zone_id}/secondary_dns/outgoing/force_notify

Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.

Primary Zone Configuration Details -> Envelope<{ id, checked_time, created_time, 4 more... }>

get/zones/{zone_id}/secondary_dns/outgoing

Get primary zone configuration for outgoing zone transfers.

Update Primary Zone Configuration -> Envelope<{ id, checked_time, created_time, 4 more... }>

put/zones/{zone_id}/secondary_dns/outgoing

Update primary zone configuration for outgoing zone transfers.

Domain types

DisableTransfer = string

The zone transfer status of a primary zone

EnableTransfer = string

The zone transfer status of a primary zone

Outgoing = { id, checked_time, created_time, 4 more... }

OutgoingStatus = string

The zone transfer status of a primary zone

Status

dns.zone_transfers.outgoing.status

Methods

Get Outgoing Zone Transfer Status -> Envelope<

EnableTransfer

get/zones/{zone_id}/secondary_dns/outgoing/status

Get primary zone transfer status.

Peers

dns.zone_transfers.peers

Methods

Create Peer -> Envelope<

post/accounts/{account_id}/secondary_dns/peers

Create Peer.

Delete Peer -> Envelope<{ id }>

delete/accounts/{account_id}/secondary_dns/peers/{peer_id}

Delete Peer.

Peer Details -> Envelope<

get/accounts/{account_id}/secondary_dns/peers/{peer_id}

Get Peer.

List Peers -> SinglePage<

get/accounts/{account_id}/secondary_dns/peers

List Peers.

Update Peer -> Envelope<

put/accounts/{account_id}/secondary_dns/peers/{peer_id}

Modify Peer.

Domain types

Peer = { id, name, ip, 3 more... }

TSIGs

dns.zone_transfers.tsigs

Methods

Create TSIG -> Envelope<

post/accounts/{account_id}/secondary_dns/tsigs

Create TSIG.

Delete TSIG -> Envelope<{ id }>

delete/accounts/{account_id}/secondary_dns/tsigs/{tsig_id}

Delete TSIG.

TSIG Details -> Envelope<

get/accounts/{account_id}/secondary_dns/tsigs/{tsig_id}

Get TSIG.

List TSIGs -> SinglePage<

get/accounts/{account_id}/secondary_dns/tsigs

List TSIGs.

Update TSIG -> Envelope<