--- title: Batch DNS Records --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [DNS](https://developers.cloudflare.com/api/python/resources/dns) [Records](https://developers.cloudflare.com/api/python/resources/dns/subresources/records) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Batch DNS Records dns.records.batch(RecordBatchParams\*\*kwargs) -> [RecordBatchResponse]() POST/zones/{zone\_id}/dns\_records/batch Send a Batch of DNS Record API calls to be executed together. Notes: - Although Cloudflare will execute the batched operations in a single database transaction, Cloudflare’s distributed KV store must treat each record change as a single key-value pair. This means that the propagation of changes is not atomic. See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/batch-record-changes/ "Batch DNS records") for more information. - The operations you specify within the /batch request body are always executed in the following order: - Deletes - Patches - Puts - Posts ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `DNS Write` ##### ParametersExpand Collapse zone\_id: str Identifier. maxLength32 [Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20batch%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) include\_shadow\_metadata: Optional\[[bool]()] Whether to include shadow metadata in the `meta` field of each record in the response. See [Shadowed records](https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). [Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20batch%20%3E%20(params)%20default%20%3E%20(param)%20include_shadow_metadata%20%3E%20(schema)>)
deletes: Optional\[Iterable\[Delete]] id: str Identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20batch%20%3E%20(params)%20default%20%3E%20(param)%20deletes%20%3E%20(schema)>)
patches: Optional\[Iterable\[BatchPatchParam]] 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. 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 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(method)%20batch%20%3E%20(params)%20default%20%3E%20(param)%20patches%20%3E%20(schema)>)
posts: Optional\[Iterable\[Post]] 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. 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 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. 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 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. 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 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. 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 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. 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 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 PostDNSRecordsOpenpgpkeyRecord: … name: str Complete DNS record name, including the zone name, in Punycode. maxLength255 minLength1 Link to this property
ttl: TTLParam 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 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\[PostDNSRecordsOpenpgpkeyRecordSettings] 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\[Sequence\[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. 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 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. 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 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. 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 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. 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 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. 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 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. 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 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. 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 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. 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 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. 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 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. 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 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. 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 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. 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 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. 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 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. 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 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. 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 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(method)%20batch%20%3E%20(params)%20default%20%3E%20(param)%20posts%20%3E%20(schema)>)
puts: Optional\[Iterable\[BatchPutParam]] 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. 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 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(method)%20batch%20%3E%20(params)%20default%20%3E%20(param)%20puts%20%3E%20(schema)>) ##### ReturnsExpand Collapse
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. 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 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. 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 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. 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 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. 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 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
[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record_batch_response%20%3E%20(schema)>) ### Batch DNS Records Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.dns.records.batch( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(response.deletes) ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "deletes": [ { "name": "example.com", "ttl": 3600, "type": "A", "comment": "Domain verification record", "content": "198.51.100.4", "private_routing": true, "proxied": true, "settings": { "ipv4_only": true, "ipv6_only": true }, "tags": [ "owner:dns-team" ], "id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2014-01-01T05:20:00.12345Z", "meta": { "dead_glue": true, "is_glue": true, "shadowed_by": [ "372e67954025e0ba6aaa6d586b9e0b59" ], "shadowed_records_count": 42 }, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "comment_modified_on": "2024-01-01T05:20:00.12345Z", "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ], "patches": [ { "name": "example.com", "ttl": 3600, "type": "A", "comment": "Domain verification record", "content": "198.51.100.4", "private_routing": true, "proxied": true, "settings": { "ipv4_only": true, "ipv6_only": true }, "tags": [ "owner:dns-team" ], "id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2014-01-01T05:20:00.12345Z", "meta": { "dead_glue": true, "is_glue": true, "shadowed_by": [ "372e67954025e0ba6aaa6d586b9e0b59" ], "shadowed_records_count": 42 }, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "comment_modified_on": "2024-01-01T05:20:00.12345Z", "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ], "posts": [ { "name": "example.com", "ttl": 3600, "type": "A", "comment": "Domain verification record", "content": "198.51.100.4", "private_routing": true, "proxied": true, "settings": { "ipv4_only": true, "ipv6_only": true }, "tags": [ "owner:dns-team" ], "id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2014-01-01T05:20:00.12345Z", "meta": { "dead_glue": true, "is_glue": true, "shadowed_by": [ "372e67954025e0ba6aaa6d586b9e0b59" ], "shadowed_records_count": 42 }, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "comment_modified_on": "2024-01-01T05:20:00.12345Z", "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ], "puts": [ { "name": "example.com", "ttl": 3600, "type": "A", "comment": "Domain verification record", "content": "198.51.100.4", "private_routing": true, "proxied": true, "settings": { "ipv4_only": true, "ipv6_only": true }, "tags": [ "owner:dns-team" ], "id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2014-01-01T05:20:00.12345Z", "meta": { "dead_glue": true, "is_glue": true, "shadowed_by": [ "372e67954025e0ba6aaa6d586b9e0b59" ], "shadowed_records_count": 42 }, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "comment_modified_on": "2024-01-01T05:20:00.12345Z", "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ] } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "deletes": [ { "name": "example.com", "ttl": 3600, "type": "A", "comment": "Domain verification record", "content": "198.51.100.4", "private_routing": true, "proxied": true, "settings": { "ipv4_only": true, "ipv6_only": true }, "tags": [ "owner:dns-team" ], "id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2014-01-01T05:20:00.12345Z", "meta": { "dead_glue": true, "is_glue": true, "shadowed_by": [ "372e67954025e0ba6aaa6d586b9e0b59" ], "shadowed_records_count": 42 }, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "comment_modified_on": "2024-01-01T05:20:00.12345Z", "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ], "patches": [ { "name": "example.com", "ttl": 3600, "type": "A", "comment": "Domain verification record", "content": "198.51.100.4", "private_routing": true, "proxied": true, "settings": { "ipv4_only": true, "ipv6_only": true }, "tags": [ "owner:dns-team" ], "id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2014-01-01T05:20:00.12345Z", "meta": { "dead_glue": true, "is_glue": true, "shadowed_by": [ "372e67954025e0ba6aaa6d586b9e0b59" ], "shadowed_records_count": 42 }, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "comment_modified_on": "2024-01-01T05:20:00.12345Z", "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ], "posts": [ { "name": "example.com", "ttl": 3600, "type": "A", "comment": "Domain verification record", "content": "198.51.100.4", "private_routing": true, "proxied": true, "settings": { "ipv4_only": true, "ipv6_only": true }, "tags": [ "owner:dns-team" ], "id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2014-01-01T05:20:00.12345Z", "meta": { "dead_glue": true, "is_glue": true, "shadowed_by": [ "372e67954025e0ba6aaa6d586b9e0b59" ], "shadowed_records_count": 42 }, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "comment_modified_on": "2024-01-01T05:20:00.12345Z", "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ], "puts": [ { "name": "example.com", "ttl": 3600, "type": "A", "comment": "Domain verification record", "content": "198.51.100.4", "private_routing": true, "proxied": true, "settings": { "ipv4_only": true, "ipv6_only": true }, "tags": [ "owner:dns-team" ], "id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2014-01-01T05:20:00.12345Z", "meta": { "dead_glue": true, "is_glue": true, "shadowed_by": [ "372e67954025e0ba6aaa6d586b9e0b59" ], "shadowed_records_count": 42 }, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "comment_modified_on": "2024-01-01T05:20:00.12345Z", "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ] } } ```