List DNS Records

client.dns.records.list(, ?): V4PagePaginationArray<RecordResponse>

GET/zones/{zone_id}/dns_records

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

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 ReadDNS Write

ParametersExpand Collapse

params: RecordListParams { zone_id, comment, content, 14 more }

zone_id: string

Path param: Identifier.

maxLength32

comment?: Comment

Query param

absent?: string

If this parameter is present, only records without a comment are returned.

contains?: string

Substring of the DNS record comment. Comment filters are case-insensitive.

endswith?: string

Suffix of the DNS record comment. Comment filters are case-insensitive.

exact?: string

Exact value of the DNS record comment. Comment filters are case-insensitive.

present?: string

If this parameter is present, only records with a comment are returned.

startswith?: string

Prefix of the DNS record comment. Comment filters are case-insensitive.

content?: Content

Query param

contains?: string

Substring of the DNS record content. Content filters are case-insensitive.

endswith?: string

Suffix of the DNS record content. Content filters are case-insensitive.

exact?: string

Exact value of the DNS record content. Content filters are case-insensitive.

startswith?: string

Prefix of the DNS record content. Content filters are case-insensitive.

direction?: SortDirection

Query param: Direction to order DNS records in.

One of the following:

"asc"

"desc"

include_shadow_metadata?: boolean

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

match?: "any" | "all"

Query param: Whether to match all search requirements or at least one (any). If set to all, acts like a logical AND between filters. If set to any, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the tag-match parameter instead.

One of the following:

"any"

"all"

name?: Name

Query param

contains?: string

Substring of the DNS record name. Name filters are case-insensitive.

endswith?: string

Suffix of the DNS record name. Name filters are case-insensitive.

exact?: string

Exact value of the DNS record name. Name filters are case-insensitive.

startswith?: string

Prefix of the DNS record name. Name filters are case-insensitive.

order?: "type" | "name" | "content" | 2 more

Query param: Field to order DNS records by.

One of the following:

"type"

"name"

"content"

"ttl"

"proxied"

page?: number

Query param: Page number of paginated results.

minimum1

per_page?: number

Query param: Number of DNS records per page.

maximum5000000

minimum1

proxied?: boolean

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

search?: string

Query param: Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the match setting. For automated searches, please use the other available parameters.

shadowed_by_name?: string

Query param: Filters to records at or below the given NS delegation name, excluding the NS records that form the delegation itself. The value must be a subdomain of the zone; the zone apex is not accepted. Requires include_shadow_metadata=true. See Shadowed records.

shadowing_name?: string

Query param: Returns NS records that shadow the given name, searching at the name itself and each of its ancestor names within the zone, excluding the zone apex. The value must be a subdomain of the zone; the zone apex is not accepted. See Shadowed records.

tag?: Tag

Query param

absent?: string

Name of a tag which must not be present on the DNS record. Tag filters are case-insensitive.

contains?: string

A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value contains <tag-value>. Tag filters are case-insensitive.

endswith?: string

A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value ends with <tag-value>. Tag filters are case-insensitive.

exact?: string

A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value is <tag-value>. Tag filters are case-insensitive.

present?: string

Name of a tag which must be present on the DNS record. Tag filters are case-insensitive.

startswith?: string

A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value starts with <tag-value>. Tag filters are case-insensitive.

tag_match?: "any" | "all"

Query param: Whether to match all tag search requirements or at least one (any). If set to all, acts like a logical AND between tag filters. If set to any, acts like a logical OR instead. Note that the regular match parameter is still used to combine the resulting condition with other filters that aren’t related to tags.

One of the following:

"any"

"all"

type?: "A" | "AAAA" | "CAA" | 18 more

Query param: Record type.

One of the following:

"A"

"AAAA"

"CAA"

"CERT"

"CNAME"

"DNSKEY"

"DS"

"HTTPS"

"LOC"

"MX"

"NAPTR"

"NS"

"OPENPGPKEY"

"PTR"

"SMIMEA"

"SRV"

"SSHFP"

"SVCB"

"TLSA"

"TXT"

"URI"

ReturnsExpand Collapse

RecordResponse = ARecord { id, created_on, meta, 4 more } | AAAARecord { id, created_on, meta, 4 more } | CNAMERecord { id, created_on, meta, 4 more } | 18 more

One of the following:

ARecord extends ARecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

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?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

AAAARecord extends AAAARecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

CNAMERecord extends CNAMERecord { name, ttl, type, 5 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

MXRecord extends MXRecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

NSRecord extends NSRecord { name, ttl, type, 5 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

OpenpgpkeyRecord { id, comment, content, 12 more }

id: string

Identifier.

maxLength32

comment: string

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

content: string

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

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

name: string

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

maxLength255

minLength1

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

proxied: boolean

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

settings: Settings { ipv4_only, ipv6_only }

Settings for the DNS record.

ipv4_only?: boolean

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?: boolean

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: Array<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:

number

type: "OPENPGPKEY"

Record type.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

PTRRecord extends PTRRecord { name, ttl, type, 5 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

TXTRecord extends TXTRecord { name, ttl, type, 5 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

CAARecord extends CAARecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

CERTRecord extends CERTRecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

DNSKEYRecord extends DNSKEYRecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

DSRecord extends DSRecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

HTTPSRecord extends HTTPSRecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

LOCRecord extends LOCRecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

NAPTRRecord extends NAPTRRecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

SMIMEARecord extends SMIMEARecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

SRVRecord extends SRVRecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

SSHFPRecord extends SSHFPRecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

SVCBRecord extends SVCBRecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

TLSARecord extends TLSARecord { name, ttl, type, 6 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

URIRecord extends URIRecord { name, ttl, type, 7 more } { id, created_on, meta, 4 more }

id: string

Identifier.

maxLength32

created_on: string

When the record was created.

formatdate-time

meta: Meta { dead_glue, is_glue, shadowed_by, shadowed_records_count }

Extra Cloudflare-specific metadata about the record.

dead_glue?: boolean

is_glue?: boolean

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

shadowed_by?: Array<string>

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

shadowed_records_count?: number

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

maximum10000

minimum0

modified_on: string

When the record was last modified.

formatdate-time

proxiable: boolean

Whether the record can be proxied by Cloudflare or not.

comment_modified_on?: string

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

formatdate-time

tags_modified_on?: string

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

formatdate-time

List DNS Records

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const recordResponse of client.dns.records.list({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(recordResponse);
}

{
  "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"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}

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"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}