--- title: List DNS Records --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [DNS](https://developers.cloudflare.com/api/resources/dns) [Records](https://developers.cloudflare.com/api/resources/dns/subresources/records) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List DNS Records 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 Read``DNS Write` ##### P ath ParametersExpand Collapse zone\_id: string Identifier. maxLength32 [Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) ##### Q uery ParametersExpand Collapse

comment: optional object {absent, contains, endswith, 3 more }

absent: optional string If this parameter is present, only records *without* a comment are returned. Link to this property contains: optional string Substring of the DNS record comment. Comment filters are case-insensitive. Link to this property endswith: optional string Suffix of the DNS record comment. Comment filters are case-insensitive. Link to this property exact: optional string Exact value of the DNS record comment. Comment filters are case-insensitive. Link to this property present: optional string If this parameter is present, only records *with* a comment are returned. Link to this property startswith: optional string Prefix of the DNS record comment. Comment filters are case-insensitive. Link to this property

[Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20comment%20%3E%20(schema)>)

content: optional object {contains, endswith, exact, startswith }

contains: optional string Substring of the DNS record content. Content filters are case-insensitive. Link to this property endswith: optional string Suffix of the DNS record content. Content filters are case-insensitive. Link to this property exact: optional string Exact value of the DNS record content. Content filters are case-insensitive. Link to this property startswith: optional string Prefix of the DNS record content. Content filters are case-insensitive. Link to this property

[Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20content%20%3E%20(schema)>)

direction: optional SortDirection Direction to order DNS records in.

One of the following: "asc" Link to this property "desc" Link to this property

[Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20direction%20%3E%20(schema)>) include\_shadow\_metadata: optional boolean 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)%20list%20%3E%20(params)%20default%20%3E%20(param)%20include_shadow_metadata%20%3E%20(schema)>)

match: optional "any"or "all" 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" Link to this property "all" Link to this property

[Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20match%20%3E%20(schema)>)

name: optional object {contains, endswith, exact, startswith }

contains: optional string Substring of the DNS record name. Name filters are case-insensitive. Link to this property endswith: optional string Suffix of the DNS record name. Name filters are case-insensitive. Link to this property exact: optional string Exact value of the DNS record name. Name filters are case-insensitive. Link to this property startswith: optional string Prefix of the DNS record name. Name filters are case-insensitive. Link to this property

[Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>)

order: optional "type"or "name"or "content"or 2 more Field to order DNS records by.

One of the following: "type" Link to this property "name" Link to this property "content" Link to this property "ttl" Link to this property "proxied" Link to this property

[Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20order%20%3E%20(schema)>) page: optional number Page number of paginated results. minimum1 [Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) per\_page: optional number Number of DNS records per page. maximum5000000 minimum1 [Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>) proxied: optional boolean Whether the record is receiving the performance and security benefits of Cloudflare. [Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20proxied%20%3E%20(schema)>) search: optional string 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. [Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20search%20%3E%20(schema)>) shadowed\_by\_name: optional string Filters the response to records at or below the specified NS delegation name. NS, DS, and NSEC records at the delegation name are excluded because they are not shadowed by that delegation. Those record types are included only when they exist below the delegation. The value must be a non-apex subdomain of the zone. Requires `include_shadow_metadata=true`. 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)%20list%20%3E%20(params)%20default%20%3E%20(param)%20shadowed_by_name%20%3E%20(schema)>) shadowing\_name: optional string 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](https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). [Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20shadowing_name%20%3E%20(schema)>)

tag: optional object {absent, contains, endswith, 3 more }

absent: optional string Name of a tag which must *not* be present on the DNS record. Tag filters are case-insensitive. Link to this property contains: optional 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. Link to this property endswith: optional 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. Link to this property exact: optional 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. Link to this property present: optional string Name of a tag which must be present on the DNS record. Tag filters are case-insensitive. Link to this property startswith: optional 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. Link to this property

[Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20tag%20%3E%20(schema)>)

tag\_match: optional "any"or "all" 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" Link to this property "all" Link to this property

[Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20tag_match%20%3E%20(schema)>)

type: optional "A"or "AAAA"or "CAA"or 18 more Record type.

[Link to this property](<#(resource)%20dns.records%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20type%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property