DNS
DNSDNSSEC
Delete DNSSEC records
ModelsExpand Collapse
type DNSSEC struct{…}
If true, multi-signer DNSSEC is enabled on the zone, allowing multiple providers to serve a DNSSEC-signed zone at the same time. This is required for DNSKEY records (except those automatically generated by Cloudflare) to be added to the zone.
See Multi-signer DNSSEC for details.
If true, allows Cloudflare to transfer in a DNSSEC-signed zone including signatures from an external provider, without requiring Cloudflare to sign any records on the fly.
Note that this feature has some limitations. See Cloudflare as Secondary for details.
If true, enables the use of NSEC3 together with DNSSEC on the zone. Combined with setting dnssec_presigned to true, this enables the use of NSEC3 records when transferring in from an external provider. If dnssec_presigned is instead set to false (default), NSEC3 records will be generated and signed at request time.
See DNSSEC with NSEC3 for details.
DNSRecords
List DNS Records
DNS Record Details
Create DNS Record
Overwrite DNS Record
Update DNS Record
Delete DNS Record
Export DNS Records
Import DNS Records
Scan DNS Records
Trigger DNS Record Scan
Review Scanned DNS Records
List Scanned DNS Records
Batch DNS Records
ModelsExpand Collapse
type ARecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings ARecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type AAAARecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings AAAARecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type BatchPatch interface{…}
BatchPatchOpenpgpkeyRecord
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings BatchPatchOpenpgpkeyRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type BatchPut interface{…}
BatchPutOpenpgpkeyRecord
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings BatchPutOpenpgpkeyRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type CAARecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings CAARecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type CERTRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings CERTRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type CNAMERecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings CNAMERecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type DNSKEYRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings DNSKEYRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type DSRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings DSRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type HTTPSRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings HTTPSRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type LOCRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Data LOCRecordDataoptionalComponents of a LOC record.
Components of a LOC record.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings LOCRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type MXRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings MXRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type NAPTRRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings NAPTRRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type NSRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings NSRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type PTRRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings PTRRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type Record interface{…}
type ARecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings ARecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type AAAARecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings AAAARecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type CNAMERecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings CNAMERecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type MXRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings MXRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type NSRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings NSRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
RecordOpenpgpkey
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings RecordOpenpgpkeySettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type PTRRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings PTRRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type TXTRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Text content for the record. The content must consist of quoted "character strings" (RFC 1035), each with a length of up to 255 bytes. Strings exceeding this allowed maximum length are automatically split.
Learn more at https://www.cloudflare.com/learning/dns/dns-records/dns-txt-record/.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings TXTRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type CAARecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings CAARecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type CERTRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings CERTRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type DNSKEYRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings DNSKEYRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type DSRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings DSRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type HTTPSRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings HTTPSRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type LOCRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Data LOCRecordDataoptionalComponents of a LOC record.
Components of a LOC record.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings LOCRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type NAPTRRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings NAPTRRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type SMIMEARecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings SMIMEARecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type SRVRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Priority, weight, port, and SRV target. See 'data' for setting the individual component values.
Data SRVRecordDataoptionalComponents of a SRV record.
Components of a SRV record.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings SRVRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type SSHFPRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings SSHFPRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type SVCBRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings SVCBRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type TLSARecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings TLSARecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type URIRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings URIRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type RecordResponse interface{…}
type RecordResponseA struct{…}
type RecordResponseAAAA struct{…}
type RecordResponseCNAME struct{…}
type RecordResponseMX struct{…}
type RecordResponseNS struct{…}
type RecordResponseOpenpgpkey struct{…}
Settings RecordResponseOpenpgpkeySettingsSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
Custom tags for the DNS record. This field has no effect on DNS responses.
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.
type RecordResponsePTR struct{…}
type RecordResponseTXT struct{…}
type RecordResponseCAA struct{…}
type RecordResponseCERT struct{…}
type RecordResponseDNSKEY struct{…}
type RecordResponseDS struct{…}
type RecordResponseHTTPS struct{…}
type RecordResponseLOC struct{…}
type RecordResponseNAPTR struct{…}
type RecordResponseSMIMEA struct{…}
type RecordResponseSRV struct{…}
type RecordResponseSSHFP struct{…}
type RecordResponseSVCB struct{…}
type RecordResponseTLSA struct{…}
type SMIMEARecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings SMIMEARecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type SRVRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Priority, weight, port, and SRV target. See 'data' for setting the individual component values.
Data SRVRecordDataoptionalComponents of a SRV record.
Components of a SRV record.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings SRVRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type SSHFPRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings SSHFPRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type SVCBRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings SVCBRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type TLSARecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings TLSARecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type TXTRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Text content for the record. The content must consist of quoted "character strings" (RFC 1035), each with a length of up to 255 bytes. Strings exceeding this allowed maximum length are automatically split.
Learn more at https://www.cloudflare.com/learning/dns/dns-records/dns-txt-record/.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings TXTRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
type URIRecord struct{…}
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.
Comments or notes about the DNS record. This field has no effect on DNS responses.
Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map.
Whether the record is receiving the performance and security benefits of Cloudflare.
Settings URIRecordSettingsoptionalSettings for the DNS record.
Settings for the DNS record.
When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
DNSUsage
DNSUsageZone
DNSUsageAccount
DNSSettings
DNSSettingsZone
Show DNS Settings
Update DNS Settings
DNSSettingsAccount
Show DNS Settings
Update DNS Settings
DNSSettingsAccountViews
List Internal DNS Views
DNS Internal View Details
Create Internal DNS View
Update Internal DNS View
Delete Internal DNS View
DNSAnalytics
DNSAnalyticsReports
ModelsExpand Collapse
type Report struct{…}
Number of seconds between current time and last processed event, in another words how many seconds of data could be missing.
Maximum results for each metric (object mapping metric names to values). Currently always an empty object.
Minimum results for each metric (object mapping metric names to values). Currently always an empty object.
DNSAnalyticsReportsBytimes
ModelsExpand Collapse
type ByTime struct{…}
Number of seconds between current time and last processed event, in another words how many seconds of data could be missing.
Maximum results for each metric (object mapping metric names to values). Currently always an empty object.
Minimum results for each metric (object mapping metric names to values). Currently always an empty object.
DNSZone Transfers
DNSZone TransfersForce AXFR
Force AXFR
DNSZone TransfersIncoming
Secondary Zone Configuration Details
Create Secondary Zone Configuration
Update Secondary Zone Configuration
Delete Secondary Zone Configuration
DNSZone TransfersOutgoing
Primary Zone Configuration Details
Create Primary Zone Configuration
Update Primary Zone Configuration
Delete Primary Zone Configuration
Disable Outgoing Zone Transfers
Enable Outgoing Zone Transfers
Force DNS NOTIFY
DNSZone TransfersOutgoingStatus
Get Outgoing Zone Transfer Status
DNSZone TransfersACLs
ACL Details
Create ACL
Update ACL
Delete ACL
ModelsExpand Collapse
type ACL struct{…}
Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will be applied for the entire account. The IP range is used to allow additional NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for IPv6 respectively.
DNSZone TransfersPeers
List Peers
Peer Details
Create Peer
Update Peer
Delete Peer
ModelsExpand Collapse
type Peer struct{…}
IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary zones this IP defines the IP of the primary nameserver Cloudflare will send AXFR/IXFR requests to.
Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.