--- title: DNS --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # DNS #### DNSDNSSEC ##### [DNSSEC Details](https://developers.cloudflare.com/api/python/resources/dns/subresources/dnssec/methods/get) dns.dnssec.get(DNSSECGetParams\*\*kwargs) -> [DNSSEC]() GET/zones/{zone\_id}/dnssec ##### [Edit DNSSEC Status](https://developers.cloudflare.com/api/python/resources/dns/subresources/dnssec/methods/edit) dns.dnssec.edit(DNSSECEditParams\*\*kwargs) -> [DNSSEC]() PATCH/zones/{zone\_id}/dnssec ##### [Delete DNSSEC records](https://developers.cloudflare.com/api/python/resources/dns/subresources/dnssec/methods/delete) dns.dnssec.delete(DNSSECDeleteParams\*\*kwargs) -> [DNSSECDeleteResponse]() DELETE/zones/{zone\_id}/dnssec ##### ModelsExpand Collapse
class DNSSEC: … algorithm: Optional\[str] Algorithm key code. Link to this property digest: Optional\[str] Digest hash. Link to this property digest\_algorithm: Optional\[str] Type of digest algorithm. Link to this property digest\_type: Optional\[str] Coded type for digest algorithm. Link to this property dnssec\_multi\_signer: Optional\[bool] 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. Link to this property dnssec\_presigned: Optional\[bool] 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. Link to this property dnssec\_use\_nsec3: Optional\[bool] 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. Link to this property ds: Optional\[str] Full DS record. Link to this property flags: Optional\[float] Flag for DNSSEC record. Link to this property key\_tag: Optional\[float] Code for key tag. Link to this property key\_type: Optional\[str] Algorithm key type. Link to this property modified\_on: Optional\[datetime] When DNSSEC was last modified. formatdate-time Link to this property public\_key: Optional\[str] Public key for DS record. Link to this property
status: Optional\[Literal\["active", "pending", "disabled", 2 more]] Status of DNSSEC, based on user-desired state and presence of necessary records. One of the following: "active" Link to this property "pending" Link to this property "disabled" Link to this property "pending-disabled" Link to this property "error" Link to this property
Link to this property
[Link to this property](<#(resource)%20dns.dnssec%20%3E%20(model)%20dnssec%20%3E%20(schema)>) str [Link to this property](<#(resource)%20dns.dnssec%20%3E%20(model)%20dnssec_delete_response%20%3E%20(schema)>) #### DNSDNSSECZsk ##### [List DNSSEC ZSKs](https://developers.cloudflare.com/api/python/resources/dns/subresources/dnssec/subresources/zsk/methods/list) dns.dnssec.zsk.list(ZskListParams\*\*kwargs) -> SyncSinglePage\[[ZskListResponse]()] GET/zones/{zone\_id}/dnssec/zsk ##### ModelsExpand Collapse
class ZskListResponse: …
dnskey: Optional\[DNSKEY] algorithm: Optional\[int] Link to this property flags: Optional\[int] Link to this property
hdr: Optional\[DNSKEYHdr] class\_: Optional\[int] Link to this property name: Optional\[str] Link to this property rdlength: Optional\[int] Link to this property rrtype: Optional\[int] Link to this property ttl: Optional\[int] Link to this property
Link to this property protocol: Optional\[int] Link to this property public\_key: Optional\[str] Link to this property
Link to this property
location: Optional\[Literal\["database", "vault"]] Storage backend where the DNSSEC key material is stored. One of the following: "database" Link to this property "vault" Link to this property
Link to this property name: Optional\[str] Internal key name for the ZSK. Link to this property
signing\_key: Optional\[SigningKey] kek: Optional\[str] Key encryption key name used to encrypt the private key. Link to this property privkey: Optional\[str] Encrypted private key material for the signing key. formatbyte Link to this property pubkey: Optional\[str] Public key content associated with the signing key. Link to this property
Link to this property
tag: Optional\[Literal\["active", "publish", "external", 3 more]] Lifecycle state tag attached to the DNSSEC key. One of the following: "active" Link to this property "publish" Link to this property "external" Link to this property "retired" Link to this property "revoked" Link to this property "removed" Link to this property
Link to this property
[Link to this property](<#(resource)%20dns.dnssec.zsk%20%3E%20(model)%20zsk_list_response%20%3E%20(schema)>) #### DNSRecords ##### [List DNS Records](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/list) dns.records.list(RecordListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[RecordResponse]()] GET/zones/{zone\_id}/dns\_records ##### [DNS Record Details](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/get) dns.records.get(strdns\_record\_id, RecordGetParams\*\*kwargs) -> [RecordResponse]() GET/zones/{zone\_id}/dns\_records/{dns\_record\_id} ##### [Create DNS Record](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/create) dns.records.create(RecordCreateParams\*\*kwargs) -> [RecordResponse]() POST/zones/{zone\_id}/dns\_records ##### [Overwrite DNS Record](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/update) dns.records.update(strdns\_record\_id, RecordUpdateParams\*\*kwargs) -> [RecordResponse]() PUT/zones/{zone\_id}/dns\_records/{dns\_record\_id} ##### [Update DNS Record](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/edit) dns.records.edit(strdns\_record\_id, RecordEditParams\*\*kwargs) -> [RecordResponse]() PATCH/zones/{zone\_id}/dns\_records/{dns\_record\_id} ##### [Delete DNS Record](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/delete) dns.records.delete(strdns\_record\_id, RecordDeleteParams\*\*kwargs) -> [RecordDeleteResponse]() DELETE/zones/{zone\_id}/dns\_records/{dns\_record\_id} ##### [Export DNS Records](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/export) dns.records.export(RecordExportParams\*\*kwargs) -> [RecordExportResponse]() GET/zones/{zone\_id}/dns\_records/export ##### [Import DNS Records](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/import) dns.records.import\_(RecordImportParams\*\*kwargs) -> [RecordImportResponse]() POST/zones/{zone\_id}/dns\_records/import ##### [Scan DNS Records](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/scan) Deprecated dns.records.scan(RecordScanParams\*\*kwargs) -> [RecordScanResponse]() POST/zones/{zone\_id}/dns\_records/scan ##### [Trigger DNS Record Scan](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/scan_trigger) dns.records.scan\_trigger(RecordScanTriggerParams\*\*kwargs) -> [RecordScanTriggerResponse]() POST/zones/{zone\_id}/dns\_records/scan/trigger ##### [Review Scanned DNS Records](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/scan_review) dns.records.scan\_review(RecordScanReviewParams\*\*kwargs) -> [RecordScanReviewResponse]() POST/zones/{zone\_id}/dns\_records/scan/review ##### [List Scanned DNS Records](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/scan_list) dns.records.scan\_list(RecordScanListParams\*\*kwargs) -> SyncSinglePage\[[RecordResponse]()] GET/zones/{zone\_id}/dns\_records/scan/review ##### [Batch DNS Records](https://developers.cloudflare.com/api/python/resources/dns/subresources/records/methods/batch) dns.records.batch(RecordBatchParams\*\*kwargs) -> [RecordBatchResponse]() POST/zones/{zone\_id}/dns\_records/batch ##### ModelsExpand Collapse
class ARecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["A"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A valid IPv4 address. formatipv4 Link to this property private\_routing: Optional\[bool] Enables private network routing to the origin. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20a_record%20%3E%20(schema)>)
class AAAARecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["AAAA"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A valid IPv6 address. formatipv6 Link to this property private\_routing: Optional\[bool] Enables private network routing to the origin. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20aaaa_record%20%3E%20(schema)>)
BatchPatch One of the following:
class ARecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class AAAARecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class CNAMERecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class MXRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class NSRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class OpenpgpkeyRecord: … id: str Identifier. maxLength32 Link to this property name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["OPENPGPKEY"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[OpenpgpkeyRecordSettings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class PTRRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class TXTRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class CAARecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class CERTRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class DNSKEYRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class DSRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class HTTPSRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class LOCRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class NAPTRRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class SMIMEARecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class SRVRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class SSHFPRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class SVCBRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class TLSARecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class URIRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20batch_patch%20%3E%20(schema)>)
BatchPut One of the following:
class ARecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class AAAARecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class CNAMERecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class MXRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class NSRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class OpenpgpkeyRecord: … id: str Identifier. maxLength32 Link to this property name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["OPENPGPKEY"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[OpenpgpkeyRecordSettings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class PTRRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class TXTRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class CAARecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class CERTRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class DNSKEYRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class DSRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class HTTPSRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class LOCRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class NAPTRRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class SMIMEARecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class SRVRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class SSHFPRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class SVCBRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class TLSARecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
class URIRecord: … id: str Identifier. maxLength32 Link to this property
Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20batch_put%20%3E%20(schema)>)
class CAARecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["CAA"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted CAA content. See ‘data’ to set CAA properties. Link to this property
data: Optional\[Data] Components of a CAA record. flags: Optional\[float] Flags for the CAA record. maximum255 minimum0 Link to this property tag: Optional\[str] Name of the property controlled by this record (e.g.: issue, issuewild, iodef). Link to this property value: Optional\[str] Value of the record. This field’s semantics depend on the chosen tag. Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20caa_record%20%3E%20(schema)>)
class CERTRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["CERT"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted CERT content. See ‘data’ to set CERT properties. Link to this property
data: Optional\[Data] Components of a CERT record. algorithm: Optional\[float] Algorithm. maximum255 minimum0 Link to this property certificate: Optional\[str] Certificate. Link to this property key\_tag: Optional\[float] Key Tag. maximum65535 minimum0 Link to this property type: Optional\[float] Type. maximum65535 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20cert_record%20%3E%20(schema)>)
class CNAMERecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["CNAME"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A valid hostname. Must not match the record’s name. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. flatten\_cname: Optional\[bool] 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. Link to this property ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20cname_record%20%3E%20(schema)>)
class DNSKEYRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["DNSKEY"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted DNSKEY content. See ‘data’ to set DNSKEY properties. Link to this property
data: Optional\[Data] Components of a DNSKEY record. algorithm: Optional\[float] Algorithm. maximum255 minimum0 Link to this property flags: Optional\[float] Flags. maximum65535 minimum0 Link to this property protocol: Optional\[float] Protocol. maximum255 minimum0 Link to this property public\_key: Optional\[str] Public Key. Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20dnskey_record%20%3E%20(schema)>)
class DSRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["DS"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted DS content. See ‘data’ to set DS properties. Link to this property
data: Optional\[Data] Components of a DS record. algorithm: Optional\[float] Algorithm. maximum255 minimum0 Link to this property digest: Optional\[str] Digest. Link to this property digest\_type: Optional\[float] Digest Type. maximum255 minimum0 Link to this property key\_tag: Optional\[float] Key Tag. maximum65535 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20ds_record%20%3E%20(schema)>)
class HTTPSRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["HTTPS"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted HTTPS content. See ‘data’ to set HTTPS properties. Link to this property
data: Optional\[Data] Components of a HTTPS record. priority: Optional\[float] Priority. maximum65535 minimum0 Link to this property target: Optional\[str] Target. Link to this property value: Optional\[str] Value. Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20https_record%20%3E%20(schema)>)
class LOCRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["LOC"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted LOC content. See ‘data’ to set LOC properties. Link to this property
data: Optional\[Data] Components of a LOC record. altitude: Optional\[float] Altitude of location in meters. maximum42849672.95 minimum-100000 Link to this property lat\_degrees: Optional\[float] Degrees of latitude. maximum90 minimum0 Link to this property
lat\_direction: Optional\[Literal\["N", "S"]] Latitude direction. One of the following: "N" Link to this property "S" Link to this property
Link to this property lat\_minutes: Optional\[float] Minutes of latitude. maximum59 minimum0 Link to this property lat\_seconds: Optional\[float] Seconds of latitude. maximum59.999 minimum0 Link to this property long\_degrees: Optional\[float] Degrees of longitude. maximum180 minimum0 Link to this property
long\_direction: Optional\[Literal\["E", "W"]] Longitude direction. One of the following: "E" Link to this property "W" Link to this property
Link to this property long\_minutes: Optional\[float] Minutes of longitude. maximum59 minimum0 Link to this property long\_seconds: Optional\[float] Seconds of longitude. maximum59.999 minimum0 Link to this property precision\_horz: Optional\[float] Horizontal precision of location. maximum90000000 minimum0 Link to this property precision\_vert: Optional\[float] Vertical precision of location. maximum90000000 minimum0 Link to this property size: Optional\[float] Size of location in meters. maximum90000000 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20loc_record%20%3E%20(schema)>)
class MXRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["MX"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A valid mail server hostname. formathostname Link to this property priority: Optional\[float] 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. maximum65535 minimum0 Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20mx_record%20%3E%20(schema)>)
class NAPTRRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["NAPTR"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted NAPTR content. See ‘data’ to set NAPTR properties. Link to this property
data: Optional\[Data] Components of a NAPTR record. flags: Optional\[str] Flags. Link to this property order: Optional\[float] Order. maximum65535 minimum0 Link to this property preference: Optional\[float] Preference. maximum65535 minimum0 Link to this property regex: Optional\[str] Regex. Link to this property replacement: Optional\[str] Replacement. Link to this property service: Optional\[str] Service. Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20naptr_record%20%3E%20(schema)>)
class NSRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["NS"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A valid name server host name. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20ns_record%20%3E%20(schema)>)
class PTRRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["PTR"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Domain name pointing to the address. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20ptr_record%20%3E%20(schema)>)
Record One of the following:
class ARecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["A"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A valid IPv4 address. formatipv4 Link to this property private\_routing: Optional\[bool] Enables private network routing to the origin. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class AAAARecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["AAAA"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A valid IPv6 address. formatipv6 Link to this property private\_routing: Optional\[bool] Enables private network routing to the origin. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class CNAMERecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["CNAME"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A valid hostname. Must not match the record’s name. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. flatten\_cname: Optional\[bool] 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. Link to this property ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class MXRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["MX"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A valid mail server hostname. formathostname Link to this property priority: Optional\[float] 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. maximum65535 minimum0 Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class NSRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["NS"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A valid name server host name. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class Openpgpkey: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["OPENPGPKEY"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[OpenpgpkeySettings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class PTRRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["PTR"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Domain name pointing to the address. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class TXTRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["TXT"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] 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/. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class CAARecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["CAA"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted CAA content. See ‘data’ to set CAA properties. Link to this property
data: Optional\[Data] Components of a CAA record. flags: Optional\[float] Flags for the CAA record. maximum255 minimum0 Link to this property tag: Optional\[str] Name of the property controlled by this record (e.g.: issue, issuewild, iodef). Link to this property value: Optional\[str] Value of the record. This field’s semantics depend on the chosen tag. Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class CERTRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["CERT"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted CERT content. See ‘data’ to set CERT properties. Link to this property
data: Optional\[Data] Components of a CERT record. algorithm: Optional\[float] Algorithm. maximum255 minimum0 Link to this property certificate: Optional\[str] Certificate. Link to this property key\_tag: Optional\[float] Key Tag. maximum65535 minimum0 Link to this property type: Optional\[float] Type. maximum65535 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class DNSKEYRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["DNSKEY"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted DNSKEY content. See ‘data’ to set DNSKEY properties. Link to this property
data: Optional\[Data] Components of a DNSKEY record. algorithm: Optional\[float] Algorithm. maximum255 minimum0 Link to this property flags: Optional\[float] Flags. maximum65535 minimum0 Link to this property protocol: Optional\[float] Protocol. maximum255 minimum0 Link to this property public\_key: Optional\[str] Public Key. Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class DSRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["DS"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted DS content. See ‘data’ to set DS properties. Link to this property
data: Optional\[Data] Components of a DS record. algorithm: Optional\[float] Algorithm. maximum255 minimum0 Link to this property digest: Optional\[str] Digest. Link to this property digest\_type: Optional\[float] Digest Type. maximum255 minimum0 Link to this property key\_tag: Optional\[float] Key Tag. maximum65535 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class HTTPSRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["HTTPS"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted HTTPS content. See ‘data’ to set HTTPS properties. Link to this property
data: Optional\[Data] Components of a HTTPS record. priority: Optional\[float] Priority. maximum65535 minimum0 Link to this property target: Optional\[str] Target. Link to this property value: Optional\[str] Value. Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class LOCRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["LOC"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted LOC content. See ‘data’ to set LOC properties. Link to this property
data: Optional\[Data] Components of a LOC record. altitude: Optional\[float] Altitude of location in meters. maximum42849672.95 minimum-100000 Link to this property lat\_degrees: Optional\[float] Degrees of latitude. maximum90 minimum0 Link to this property
lat\_direction: Optional\[Literal\["N", "S"]] Latitude direction. One of the following: "N" Link to this property "S" Link to this property
Link to this property lat\_minutes: Optional\[float] Minutes of latitude. maximum59 minimum0 Link to this property lat\_seconds: Optional\[float] Seconds of latitude. maximum59.999 minimum0 Link to this property long\_degrees: Optional\[float] Degrees of longitude. maximum180 minimum0 Link to this property
long\_direction: Optional\[Literal\["E", "W"]] Longitude direction. One of the following: "E" Link to this property "W" Link to this property
Link to this property long\_minutes: Optional\[float] Minutes of longitude. maximum59 minimum0 Link to this property long\_seconds: Optional\[float] Seconds of longitude. maximum59.999 minimum0 Link to this property precision\_horz: Optional\[float] Horizontal precision of location. maximum90000000 minimum0 Link to this property precision\_vert: Optional\[float] Vertical precision of location. maximum90000000 minimum0 Link to this property size: Optional\[float] Size of location in meters. maximum90000000 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class NAPTRRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["NAPTR"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted NAPTR content. See ‘data’ to set NAPTR properties. Link to this property
data: Optional\[Data] Components of a NAPTR record. flags: Optional\[str] Flags. Link to this property order: Optional\[float] Order. maximum65535 minimum0 Link to this property preference: Optional\[float] Preference. maximum65535 minimum0 Link to this property regex: Optional\[str] Regex. Link to this property replacement: Optional\[str] Replacement. Link to this property service: Optional\[str] Service. Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class SMIMEARecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["SMIMEA"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted SMIMEA content. See ‘data’ to set SMIMEA properties. Link to this property
data: Optional\[Data] Components of a SMIMEA record. certificate: Optional\[str] Certificate. Link to this property matching\_type: Optional\[float] Matching Type. maximum255 minimum0 Link to this property selector: Optional\[float] Selector. maximum255 minimum0 Link to this property usage: Optional\[float] Usage. maximum255 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class SRVRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["SRV"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Priority, weight, port, and SRV target. See ‘data’ for setting the individual component values. Link to this property
data: Optional\[Data] Components of a SRV record. port: Optional\[float] The port of the service. maximum65535 minimum0 Link to this property priority: Optional\[float] 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. maximum65535 minimum0 Link to this property target: Optional\[str] A valid hostname. formathostname Link to this property weight: Optional\[float] The record weight. maximum65535 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class SSHFPRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["SSHFP"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted SSHFP content. See ‘data’ to set SSHFP properties. Link to this property
data: Optional\[Data] Components of a SSHFP record. algorithm: Optional\[float] Algorithm. maximum255 minimum0 Link to this property fingerprint: Optional\[str] Fingerprint. Link to this property type: Optional\[float] Type. maximum255 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class SVCBRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["SVCB"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted SVCB content. See ‘data’ to set SVCB properties. Link to this property
data: Optional\[Data] Components of a SVCB record. priority: Optional\[float] Priority. maximum65535 minimum0 Link to this property target: Optional\[str] Target. Link to this property value: Optional\[str] Value. Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class TLSARecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["TLSA"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted TLSA content. See ‘data’ to set TLSA properties. Link to this property
data: Optional\[Data] Components of a TLSA record. certificate: Optional\[str] Certificate. Link to this property matching\_type: Optional\[float] Matching Type. maximum255 minimum0 Link to this property selector: Optional\[float] Selector. maximum255 minimum0 Link to this property usage: Optional\[float] Usage. maximum255 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
class URIRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["URI"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted URI content. See ‘data’ to set URI properties. Link to this property
data: Optional\[Data] Components of a URI record. target: Optional\[str] The record content. Link to this property weight: Optional\[float] The record weight. maximum65535 minimum0 Link to this property
Link to this property priority: Optional\[float] 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. maximum65535 minimum0 Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record%20%3E%20(schema)>)
RecordResponse One of the following:
class ARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: ARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class AAAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: AAAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CNAMERecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CNAMERecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class MXRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: MXRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class OpenpgpkeyRecord: … id: str Identifier. maxLength32 Link to this property comment: str Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: str A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: OpenpgpkeyRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property proxied: bool Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: OpenpgpkeyRecordSettings Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: List\[RecordTags] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property ttl: TTL 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. Link to this property type: Literal\["OPENPGPKEY"] Record type. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class PTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: PTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TXTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TXTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CERTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CERTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DNSKEYRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DNSKEYRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class HTTPSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: HTTPSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class LOCRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: LOCRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NAPTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NAPTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SMIMEARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SMIMEARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SRVRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SRVRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SSHFPRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SSHFPRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SVCBRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SVCBRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TLSARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TLSARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class URIRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: URIRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record_response%20%3E%20(schema)>) str Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens) [Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record_tags%20%3E%20(schema)>)
class SMIMEARecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["SMIMEA"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted SMIMEA content. See ‘data’ to set SMIMEA properties. Link to this property
data: Optional\[Data] Components of a SMIMEA record. certificate: Optional\[str] Certificate. Link to this property matching\_type: Optional\[float] Matching Type. maximum255 minimum0 Link to this property selector: Optional\[float] Selector. maximum255 minimum0 Link to this property usage: Optional\[float] Usage. maximum255 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20smimea_record%20%3E%20(schema)>)
class SRVRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["SRV"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Priority, weight, port, and SRV target. See ‘data’ for setting the individual component values. Link to this property
data: Optional\[Data] Components of a SRV record. port: Optional\[float] The port of the service. maximum65535 minimum0 Link to this property priority: Optional\[float] 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. maximum65535 minimum0 Link to this property target: Optional\[str] A valid hostname. formathostname Link to this property weight: Optional\[float] The record weight. maximum65535 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20srv_record%20%3E%20(schema)>)
class SSHFPRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["SSHFP"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted SSHFP content. See ‘data’ to set SSHFP properties. Link to this property
data: Optional\[Data] Components of a SSHFP record. algorithm: Optional\[float] Algorithm. maximum255 minimum0 Link to this property fingerprint: Optional\[str] Fingerprint. Link to this property type: Optional\[float] Type. maximum255 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20sshfp_record%20%3E%20(schema)>)
class SVCBRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["SVCB"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted SVCB content. See ‘data’ to set SVCB properties. Link to this property
data: Optional\[Data] Components of a SVCB record. priority: Optional\[float] Priority. maximum65535 minimum0 Link to this property target: Optional\[str] Target. Link to this property value: Optional\[str] Value. Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20svcb_record%20%3E%20(schema)>)
class TLSARecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["TLSA"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted TLSA content. See ‘data’ to set TLSA properties. Link to this property
data: Optional\[Data] Components of a TLSA record. certificate: Optional\[str] Certificate. Link to this property matching\_type: Optional\[float] Matching Type. maximum255 minimum0 Link to this property selector: Optional\[float] Selector. maximum255 minimum0 Link to this property usage: Optional\[float] Usage. maximum255 minimum0 Link to this property
Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20tlsa_record%20%3E%20(schema)>)
Union\[float, Literal\[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. One of the following: float Link to this property Literal\[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. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20ttl%20%3E%20(schema)>)
class TXTRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["TXT"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] 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/. Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20txt_record%20%3E%20(schema)>)
class URIRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property ttl: TTL 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. Link to this property type: Literal\["URI"] Record type. Link to this property comment: Optional\[str] Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: Optional\[str] Formatted URI content. See ‘data’ to set URI properties. Link to this property
data: Optional\[Data] Components of a URI record. target: Optional\[str] The record content. Link to this property weight: Optional\[float] The record weight. maximum65535 minimum0 Link to this property
Link to this property priority: Optional\[float] 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. maximum65535 minimum0 Link to this property proxied: Optional\[bool] Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: Optional\[Settings] Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: Optional\[List\[RecordTags]] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20uri_record%20%3E%20(schema)>)
class RecordDeleteResponse: … id: Optional\[str] Identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record_delete_response%20%3E%20(schema)>) str Exported BIND zone file. [Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record_export_response%20%3E%20(schema)>)
class RecordImportResponse: … recs\_added: Optional\[float] Number of DNS records added. Link to this property total\_records\_parsed: Optional\[float] Total number of DNS records parsed. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record_import_response%20%3E%20(schema)>)
class RecordScanResponse: … recs\_added: Optional\[float] Number of DNS records added. Link to this property total\_records\_parsed: Optional\[float] Total number of DNS records parsed. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record_scan_response%20%3E%20(schema)>)
class RecordScanTriggerResponse: …
errors: List\[Error] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[ErrorSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property
messages: List\[Message] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[MessageSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property success: Literal\[true] Whether the API call was successful. Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record_scan_trigger_response%20%3E%20(schema)>)
class RecordScanReviewResponse: …
accepts: Optional\[List\[RecordResponse]] One of the following:
class ARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: ARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class AAAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: AAAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CNAMERecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CNAMERecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class MXRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: MXRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class OpenpgpkeyRecord: … id: str Identifier. maxLength32 Link to this property comment: str Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: str A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: OpenpgpkeyRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property proxied: bool Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: OpenpgpkeyRecordSettings Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: List\[RecordTags] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property ttl: TTL 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. Link to this property type: Literal\["OPENPGPKEY"] Record type. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class PTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: PTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TXTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TXTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CERTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CERTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DNSKEYRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DNSKEYRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class HTTPSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: HTTPSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class LOCRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: LOCRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NAPTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NAPTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SMIMEARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SMIMEARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SRVRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SRVRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SSHFPRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SSHFPRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SVCBRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SVCBRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TLSARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TLSARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class URIRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: URIRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
Link to this property rejects: Optional\[List\[str]] Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record_scan_review_response%20%3E%20(schema)>)
class RecordBatchResponse: …
deletes: Optional\[List\[RecordResponse]] One of the following:
class ARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: ARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class AAAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: AAAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CNAMERecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CNAMERecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class MXRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: MXRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class OpenpgpkeyRecord: … id: str Identifier. maxLength32 Link to this property comment: str Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: str A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: OpenpgpkeyRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property proxied: bool Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: OpenpgpkeyRecordSettings Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: List\[RecordTags] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property ttl: TTL 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. Link to this property type: Literal\["OPENPGPKEY"] Record type. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class PTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: PTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TXTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TXTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CERTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CERTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DNSKEYRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DNSKEYRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class HTTPSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: HTTPSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class LOCRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: LOCRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NAPTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NAPTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SMIMEARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SMIMEARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SRVRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SRVRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SSHFPRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SSHFPRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SVCBRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SVCBRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TLSARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TLSARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class URIRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: URIRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
Link to this property
patches: Optional\[List\[RecordResponse]] One of the following:
class ARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: ARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class AAAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: AAAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CNAMERecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CNAMERecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class MXRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: MXRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class OpenpgpkeyRecord: … id: str Identifier. maxLength32 Link to this property comment: str Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: str A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: OpenpgpkeyRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property proxied: bool Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: OpenpgpkeyRecordSettings Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: List\[RecordTags] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property ttl: TTL 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. Link to this property type: Literal\["OPENPGPKEY"] Record type. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class PTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: PTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TXTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TXTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CERTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CERTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DNSKEYRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DNSKEYRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class HTTPSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: HTTPSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class LOCRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: LOCRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NAPTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NAPTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SMIMEARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SMIMEARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SRVRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SRVRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SSHFPRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SSHFPRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SVCBRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SVCBRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TLSARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TLSARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class URIRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: URIRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
Link to this property
posts: Optional\[List\[RecordResponse]] One of the following:
class ARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: ARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class AAAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: AAAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CNAMERecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CNAMERecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class MXRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: MXRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class OpenpgpkeyRecord: … id: str Identifier. maxLength32 Link to this property comment: str Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: str A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: OpenpgpkeyRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property proxied: bool Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: OpenpgpkeyRecordSettings Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: List\[RecordTags] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property ttl: TTL 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. Link to this property type: Literal\["OPENPGPKEY"] Record type. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class PTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: PTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TXTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TXTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CERTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CERTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DNSKEYRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DNSKEYRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class HTTPSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: HTTPSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class LOCRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: LOCRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NAPTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NAPTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SMIMEARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SMIMEARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SRVRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SRVRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SSHFPRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SSHFPRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SVCBRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SVCBRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TLSARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TLSARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class URIRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: URIRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
Link to this property
puts: Optional\[List\[RecordResponse]] One of the following:
class ARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: ARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class AAAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: AAAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CNAMERecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CNAMERecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class MXRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: MXRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class OpenpgpkeyRecord: … id: str Identifier. maxLength32 Link to this property comment: str Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property content: str A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: OpenpgpkeyRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property proxied: bool Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property
settings: OpenpgpkeyRecordSettings Settings for the DNS record. ipv4\_only: Optional\[bool] 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. Link to this property ipv6\_only: Optional\[bool] 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. Link to this property
Link to this property tags: List\[RecordTags] Custom tags for the DNS record. This field has no effect on DNS responses. Link to this property ttl: TTL 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. Link to this property type: Literal\["OPENPGPKEY"] Record type. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class PTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: PTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class TXTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: TXTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CAARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CAARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class CERTRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: CERTRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DNSKEYRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DNSKEYRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class DSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: DSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class HTTPSRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: HTTPSRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class LOCRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: LOCRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class NAPTRRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: NAPTRRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SMIMEARecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SMIMEARecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property proxiable: bool Whether the record can be proxied by Cloudflare or not. Link to this property comment\_modified\_on: Optional\[datetime] When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property tags\_modified\_on: Optional\[datetime] When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property
Link to this property
class SRVRecord: … id: str Identifier. maxLength32 Link to this property created\_on: datetime When the record was created. formatdate-time Link to this property
meta: SRVRecordMeta Extra Cloudflare-specific metadata about the record. dead\_glue: Optional\[bool] Whether this glue record is not served because a shallower NS delegation takes precedence over the deeper delegation that needs it. Present only when true; reachable glue carries only is_glue. See Unreachable glue records. Link to this property is\_glue: Optional\[bool] Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property shadowed\_by: Optional\[List\[str]] IDs of the NS records that shadow this record. See Shadowed records. Link to this property shadowed\_records\_count: Optional\[int] Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property
Link to this property modified\_on: datetime When the record was last modified. formatdate-time Link to this property