LogoCloudflare API

DNS

DNS

DNS

Analytics

DNS.Analytics

DNSAnalytics

Reports

DNS.Analytics.Reports

Methods

get(, ):
Report
get/zones/{zone_id}/dns_analytics/report

Retrieves a list of summarised aggregate metrics over a given time period.

See Analytics API properties for detailed information about the available query parameters.

Domain types

Report{…}
DNSAnalyticsReports

Bytimes

DNS.Analytics.Reports.Bytimes

Methods

get(, ):
ByTime
get/zones/{zone_id}/dns_analytics/report/bytime

Retrieves a list of aggregate metrics grouped by time interval.

See Analytics API properties for detailed information about the available query parameters.

Domain types

ByTime{…}
DNS

DNSSEC

DNS.DNSSECResource

Methods

get(, ):
DNSSEC
get/zones/{zone_id}/dnssec

Details about DNSSEC status and configuration.

edit(, ):
DNSSEC
patch/zones/{zone_id}/dnssec

Enable or disable DNSSEC.

delete(, ):
DNSSECDeleteResponse
delete/zones/{zone_id}/dnssec

Delete DNSSEC.

Domain types

DNSSEC{…}
DNS

Records

DNS.Records

Methods

list(, ):
V4PagePaginationArray
<
RecordResponse
>
get/zones/{zone_id}/dns_records

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

get(, , ):
RecordResponse
get/zones/{zone_id}/dns_records/{dns_record_id}

DNS Record Details

create(, ):
RecordResponse
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.
update(, , ):
RecordResponse
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.
edit(, , ):
RecordResponse
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.
delete(, , ):
RecordDeleteResponse
delete/zones/{zone_id}/dns_records/{dns_record_id}

Delete DNS Record

export(, ):
RecordExportResponse
get/zones/{zone_id}/dns_records/export

You can export your BIND config through this endpoint.

See the documentation for more information.

import(, ):
RecordImportResponse
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.

scan(, ):
RecordScanResponse
Deprecated
post/zones/{zone_id}/dns_records/scan

Deprecated

This endpoint is deprecated in favor of a new asynchronous version. Please use the /scan/trigger and /scan/review endpoints instead.

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

scanTrigger(, ):
RecordScanTriggerResponse
post/zones/{zone_id}/dns_records/scan/trigger

Initiates an asynchronous scan for common DNS records on your domain. Note that this does not automatically add records to your zone. The scan runs in the background, and results can be reviewed later using the /scan/review endpoints. Useful if you haven't updated your nameservers yet.

scanReview(, ):
RecordScanReviewResponse
post/zones/{zone_id}/dns_records/scan/review

Accept or reject DNS records found by the DNS records scan. Accepted records will be permanently added to the zone, while rejected records will be permanently deleted.

scanList(, ):
SinglePage
<
RecordResponse
>
get/zones/{zone_id}/dns_records/scan/review

Retrieves the list of DNS records discovered up to this point by the asynchronous scan. These records are temporary until explicitly accepted or rejected via POST /scan/review. Additional records may be discovered by the scan later.

batch(, ):
RecordBatchResponse
post/zones/{zone_id}/dns_records/batch

Send a Batch of DNS Record API calls to be executed together.

Notes:

  • Although Cloudflare will execute the batched operations in a single database transaction, Cloudflare's distributed KV store must treat each record change as a single key-value pair. This means that the propagation of changes is not atomic. See the documentation for more information.

  • The operations you specify within the /batch request body are always executed in the following order:

    • Deletes
    • Patches
    • Puts
    • Posts

Domain types

ARecord{…}
AAAARecord{…}
BatchPatch =
ARecord
|
AAAARecord
|
CNAMERecord
| 18 more...
BatchPut =
ARecord
|
AAAARecord
|
CNAMERecord
| 18 more...
CAARecord{…}
CERTRecord{…}
CNAMERecord{…}
DNSKEYRecord{…}
DSRecord{…}
HTTPSRecord{…}
LOCRecord{…}
MXRecord{…}
NAPTRRecord{…}
NSRecord{…}
PTRRecord{…}
Record =
ARecord
|
AAAARecord
|
CNAMERecord
| 18 more...
RecordResponse =
A
|
AAAA
|
CNAME
| 18 more...
RecordTags = string

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

SMIMEARecord{…}
SRVRecord{…}
SSHFPRecord{…}
SVCBRecord{…}
TLSARecord{…}
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{…}
URIRecord{…}
DNS

Settings

DNS.Settings

DNSSettings

Account

DNS.Settings.Account

Methods

get(, ):
AccountGetResponse
get/accounts/{account_id}/dns_settings

Show DNS settings for an account

edit(, ):
AccountEditResponse
patch/accounts/{account_id}/dns_settings

Update DNS settings for an account

DNSSettingsAccount

Views

DNS.Settings.Account.Views

Methods

list(, ):
V4PagePaginationArray
<
ViewListResponse
>
get/accounts/{account_id}/dns_settings/views

List DNS Internal Views for an Account

get(, , ):
ViewGetResponse
get/accounts/{account_id}/dns_settings/views/{view_id}

Get DNS Internal View

create(, ):
ViewCreateResponse
post/accounts/{account_id}/dns_settings/views

Create Internal DNS View for an account

edit(, , ):
ViewEditResponse
patch/accounts/{account_id}/dns_settings/views/{view_id}

Update an existing Internal DNS View

delete(, , ):
ViewDeleteResponse
delete/accounts/{account_id}/dns_settings/views/{view_id}

Delete an existing Internal DNS View

DNSSettings

Zone

DNS.Settings.Zone

Methods

get(, ):
ZoneGetResponse
get/zones/{zone_id}/dns_settings

Show DNS settings for a zone

edit(, ):
ZoneEditResponse
patch/zones/{zone_id}/dns_settings

Update DNS settings for a zone

DNS

Zone Transfers

DNS.ZoneTransfers

DNSZone Transfers

ACLs

DNS.ZoneTransfers.ACLs

Methods

list(, ):
SinglePage
<
ACL
>
get/accounts/{account_id}/secondary_dns/acls

List ACLs.

get(, , ):
ACL
get/accounts/{account_id}/secondary_dns/acls/{acl_id}

Get ACL.

create(, ):
ACL
post/accounts/{account_id}/secondary_dns/acls

Create ACL.

update(, , ):
ACL
put/accounts/{account_id}/secondary_dns/acls/{acl_id}

Modify ACL.

delete(, , ):
ACLDeleteResponse
delete/accounts/{account_id}/secondary_dns/acls/{acl_id}

Delete ACL.

Domain types

ACL{…}
DNSZone Transfers

Force AXFR

DNS.ZoneTransfers.ForceAXFRResource

Methods

create(, ):
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.

DNSZone Transfers

Incoming

DNS.ZoneTransfers.IncomingResource

Methods

get(, ):
IncomingGetResponse
get/zones/{zone_id}/secondary_dns/incoming

Get secondary zone configuration for incoming zone transfers.

create(, ):
IncomingCreateResponse
post/zones/{zone_id}/secondary_dns/incoming

Create secondary zone configuration for incoming zone transfers.

update(, ):
IncomingUpdateResponse
put/zones/{zone_id}/secondary_dns/incoming

Update secondary zone configuration for incoming zone transfers.

delete(, ):
IncomingDeleteResponse
delete/zones/{zone_id}/secondary_dns/incoming

Delete secondary zone configuration for incoming zone transfers.

Domain types

Incoming{…}
DNSZone Transfers

Outgoing

DNS.ZoneTransfers.OutgoingResource

Methods

get(, ):
OutgoingGetResponse
get/zones/{zone_id}/secondary_dns/outgoing

Get primary zone configuration for outgoing zone transfers.

create(, ):
OutgoingCreateResponse
post/zones/{zone_id}/secondary_dns/outgoing

Create primary zone configuration for outgoing zone transfers.

update(, ):
OutgoingUpdateResponse
put/zones/{zone_id}/secondary_dns/outgoing

Update primary zone configuration for outgoing zone transfers.

delete(, ):
OutgoingDeleteResponse
delete/zones/{zone_id}/secondary_dns/outgoing

Delete primary zone configuration for outgoing zone transfers.

disable(, ):
DisableTransfer
post/zones/{zone_id}/secondary_dns/outgoing/disable

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

enable(, ):
EnableTransfer
post/zones/{zone_id}/secondary_dns/outgoing/enable

Enable outgoing zone transfers for primary zone.

forceNotify(, ):
OutgoingForceNotifyResponse
post/zones/{zone_id}/secondary_dns/outgoing/force_notify

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

Domain types

DisableTransfer = string

The zone transfer status of a primary zone.

EnableTransfer = string

The zone transfer status of a primary zone.

Outgoing{…}
OutgoingStatus = string | null

The zone transfer status of a primary zone.

DNSZone TransfersOutgoing

Status

DNS.ZoneTransfers.OutgoingResource.Status

Methods

get(, ):
EnableTransfer
get/zones/{zone_id}/secondary_dns/outgoing/status

Get primary zone transfer status.

DNSZone Transfers

Peers

DNS.ZoneTransfers.Peers

Methods

list(, ):
SinglePage
<
Peer
>
get/accounts/{account_id}/secondary_dns/peers

List Peers.

get(, , ):
Peer
get/accounts/{account_id}/secondary_dns/peers/{peer_id}

Get Peer.

create(, ):
Peer
post/accounts/{account_id}/secondary_dns/peers

Create Peer.

update(, , ):
Peer
put/accounts/{account_id}/secondary_dns/peers/{peer_id}

Modify Peer.

delete(, , ):
PeerDeleteResponse
delete/accounts/{account_id}/secondary_dns/peers/{peer_id}

Delete Peer.

Domain types

Peer{…}
DNSZone Transfers

TSIGs

DNS.ZoneTransfers.TSIGs

Methods

list(, ):
SinglePage
<
TSIG
>
get/accounts/{account_id}/secondary_dns/tsigs

List TSIGs.

get(, , ):
TSIG
get/accounts/{account_id}/secondary_dns/tsigs/{tsig_id}

Get TSIG.

create(, ):
TSIG
post/accounts/{account_id}/secondary_dns/tsigs

Create TSIG.

update(, , ):
TSIG
put/accounts/{account_id}/secondary_dns/tsigs/{tsig_id}

Modify TSIG.

delete(, , ):
TSIGDeleteResponse
delete/accounts/{account_id}/secondary_dns/tsigs/{tsig_id}

Delete TSIG.

Domain types

TSIG{…}