Skip to content
Cloudflare API
Start here
API Reference
DNS
Records

Create DNS Record

dns.records.create(RecordCreateParams**kwargs) -> RecordResponse
POST/zones/{zone_id}/dns_records

Create a new DNS record for a zone.

Notes:

  • A/AAAA records cannot exist on the same name as CNAME records.
  • NS records cannot exist on the same name as any other record type.
  • Domain names are always represented in Punycode, even if Unicode characters were used when creating the record.
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
name: str

Complete DNS record name, including the zone name, in Punycode.

maxLength255
minLength1
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
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.

type: Literal["A"]

Record type.

include_shadow_metadata: Optional[bool]

Whether to include shadow metadata in the meta field of each record in the response. See Shadowed records.

comment: Optional[str]

Comments or notes about the DNS record. This field has no effect on DNS responses.

content: Optional[str]

A valid IPv4 address.

formatipv4
private_routing: Optional[bool]

Enables private network routing to the origin.

proxied: Optional[bool]

Whether the record is receiving the performance and security benefits of Cloudflare.

settings: Optional[ARecordSettings]

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.

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.

tags: Optional[Sequence[RecordTags]]

Custom tags for the DNS record. This field has no effect on DNS responses.

ReturnsExpand Collapse
One of the following:
class ARecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class AAAARecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class CNAMERecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class MXRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class NSRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class OpenpgpkeyRecord: …
id: str

Identifier.

maxLength32
comment: str

Comments or notes about the DNS record. This field has no effect on DNS responses.

content: str

A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)

created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
name: str

Complete DNS record name, including the zone name, in Punycode.

maxLength255
minLength1
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

proxied: bool

Whether the record is receiving the performance and security benefits of Cloudflare.

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.

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.

tags: List[RecordTags]

Custom tags for the DNS record. This field has no effect on DNS responses.

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
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.

type: Literal["OPENPGPKEY"]

Record type.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class PTRRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class TXTRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class CAARecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class CERTRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class DNSKEYRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class DSRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class HTTPSRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class LOCRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class NAPTRRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class SMIMEARecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class SRVRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class SSHFPRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class SVCBRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class TLSARecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time
class URIRecord: …
id: str

Identifier.

maxLength32
created_on: datetime

When the record was created.

formatdate-time
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.

is_glue: Optional[bool]

Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records.

shadowed_by: Optional[List[str]]

IDs of the NS records that shadow this record. See Shadowed records.

shadowed_records_count: Optional[int]

Number of records shadowed by this NS delegation. See Shadowed records.

maximum10000
minimum0
modified_on: datetime

When the record was last modified.

formatdate-time
proxiable: bool

Whether the record can be proxied by Cloudflare or not.

comment_modified_on: Optional[datetime]

When the record comment was last modified. Omitted if there is no comment.

formatdate-time
tags_modified_on: Optional[datetime]

When the record tags were last modified. Omitted if there are no tags.

formatdate-time

Create DNS Record

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
record_response = client.dns.records.create(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    name="example.com",
    ttl=3600,
    type="A",
)
print(record_response)
{
  "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": {
    "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
{
  "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": {
    "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"
  }
}