--- title: List DNS Records --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [DNS](https://developers.cloudflare.com/api/go/resources/dns) [Records](https://developers.cloudflare.com/api/go/resources/dns/subresources/records) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List DNS Records client.DNS.Records.List(ctx, params) (\*V4PagePaginationArray\[[RecordResponse]()], error) 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` ##### ParametersExpand Collapse

params RecordListParams

ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property

Comment param.Field\[RecordListParamsComment]Optional Query param

Absent stringOptional If this parameter is present, only records *without* a comment are returned. Link to this property Contains stringOptional Substring of the DNS record comment. Comment filters are case-insensitive. Link to this property Endswith stringOptional Suffix of the DNS record comment. Comment filters are case-insensitive. Link to this property Exact stringOptional Exact value of the DNS record comment. Comment filters are case-insensitive. Link to this property Present stringOptional If this parameter is present, only records *with* a comment are returned. Link to this property Startswith stringOptional Prefix of the DNS record comment. Comment filters are case-insensitive. Link to this property

Link to this property

Content param.Field\[RecordListParamsContent]Optional Query param

Contains stringOptional Substring of the DNS record content. Content filters are case-insensitive. Link to this property Endswith stringOptional Suffix of the DNS record content. Content filters are case-insensitive. Link to this property Exact stringOptional Exact value of the DNS record content. Content filters are case-insensitive. Link to this property Startswith stringOptional Prefix of the DNS record content. Content filters are case-insensitive. Link to this property

Link to this property Direction param.Field\[SortDirection]Optional Query param: Direction to order DNS records in. Link to this property IncludeShadowMetadata param.Field\[bool]Optional Query param: Whether to include shadow metadata in the meta field of each record in the response. See Shadowed records. Link to this property

Match param.Field\[RecordListParamsMatch]Optional 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.

const RecordListParamsMatchAny RecordListParamsMatch = "any" Link to this property const RecordListParamsMatchAll RecordListParamsMatch = "all" Link to this property

Link to this property

Name param.Field\[RecordListParamsName]Optional Query param

Contains stringOptional Substring of the DNS record name. Name filters are case-insensitive. Link to this property Endswith stringOptional Suffix of the DNS record name. Name filters are case-insensitive. Link to this property Exact stringOptional Exact value of the DNS record name. Name filters are case-insensitive. Link to this property Startswith stringOptional Prefix of the DNS record name. Name filters are case-insensitive. Link to this property

Link to this property

Order param.Field\[RecordListParamsOrder]Optional Query param: Field to order DNS records by.

const RecordListParamsOrderType RecordListParamsOrder = "type" Link to this property const RecordListParamsOrderName RecordListParamsOrder = "name" Link to this property const RecordListParamsOrderContent RecordListParamsOrder = "content" Link to this property const RecordListParamsOrderTTL RecordListParamsOrder = "ttl" Link to this property const RecordListParamsOrderProxied RecordListParamsOrder = "proxied" Link to this property

Link to this property Page param.Field\[float64]Optional Query param: Page number of paginated results. minimum1 Link to this property PerPage param.Field\[float64]Optional Query param: Number of DNS records per page. maximum5000000 minimum1 Link to this property Proxied param.Field\[bool]Optional Query param: Whether the record is receiving the performance and security benefits of Cloudflare. Link to this property Search param.Field\[string]Optional 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. Link to this property ShadowedByName param.Field\[string]Optional Query param: 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. Link to this property ShadowingName param.Field\[string]Optional 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. Link to this property

Tag param.Field\[RecordListParamsTag]Optional Query param

Absent stringOptional Name of a tag which must *not* be present on the DNS record. Tag filters are case-insensitive. Link to this property Contains stringOptional 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 stringOptional 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 stringOptional 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 stringOptional Name of a tag which must be present on the DNS record. Tag filters are case-insensitive. Link to this property Startswith stringOptional 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

TagMatch param.Field\[RecordListParamsTagMatch]Optional 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.

const RecordListParamsTagMatchAny RecordListParamsTagMatch = "any" Link to this property const RecordListParamsTagMatchAll RecordListParamsTagMatch = "all" Link to this property

Link to this property

Type param.Field\[RecordListParamsType]Optional Query param: Record type.

const RecordListParamsTypeA RecordListParamsType = "A" Link to this property const RecordListParamsTypeAAAA RecordListParamsType = "AAAA" Link to this property const RecordListParamsTypeCAA RecordListParamsType = "CAA" Link to this property const RecordListParamsTypeCERT RecordListParamsType = "CERT" Link to this property const RecordListParamsTypeCNAME RecordListParamsType = "CNAME" Link to this property const RecordListParamsTypeDNSKEY RecordListParamsType = "DNSKEY" Link to this property const RecordListParamsTypeDS RecordListParamsType = "DS" Link to this property const RecordListParamsTypeHTTPS RecordListParamsType = "HTTPS" Link to this property const RecordListParamsTypeLOC RecordListParamsType = "LOC" Link to this property const RecordListParamsTypeMX RecordListParamsType = "MX" Link to this property const RecordListParamsTypeNAPTR RecordListParamsType = "NAPTR" Link to this property const RecordListParamsTypeNS RecordListParamsType = "NS" Link to this property const RecordListParamsTypeOpenpgpkey RecordListParamsType = "OPENPGPKEY" Link to this property const RecordListParamsTypePTR RecordListParamsType = "PTR" Link to this property const RecordListParamsTypeSMIMEA RecordListParamsType = "SMIMEA" Link to this property const RecordListParamsTypeSRV RecordListParamsType = "SRV" Link to this property const RecordListParamsTypeSSHFP RecordListParamsType = "SSHFP" Link to this property const RecordListParamsTypeSVCB RecordListParamsType = "SVCB" Link to this property const RecordListParamsTypeTLSA RecordListParamsType = "TLSA" Link to this property const RecordListParamsTypeTXT RecordListParamsType = "TXT" Link to this property const RecordListParamsTypeURI RecordListParamsType = "URI" Link to this property

Link to this property

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

type RecordResponse interface{…}

One of the following:

type RecordResponseARecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseARecordMeta Extra Cloudflare-specific metadata about the record.

DeadGlue boolOptional 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 IsGlue boolOptional Whether this A or AAAA record is glue for a subdomain NS delegation. See Glue records. Link to this property ShadowedBy \[]stringOptional IDs of the NS records that shadow this record. See Shadowed records. Link to this property ShadowedRecordsCount int64Optional Number of records shadowed by this NS delegation. See Shadowed records. maximum10000 minimum0 Link to this property

Link to this property ModifiedOn Time 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 CommentModifiedOn TimeOptional When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property TagsModifiedOn TimeOptional When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property

Link to this property

type RecordResponseAAAARecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseAAAARecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseCNAMERecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseCNAMERecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseMXRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseMXRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseNSRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseNSRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseOpenpgpkeyRecord struct{…}

ID string Identifier. maxLength32 Link to this property Comment string Comments or notes about the DNS record. This field has no effect on DNS responses. Link to this property Content string A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseOpenpgpkeyRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property ModifiedOn Time When the record was last modified. formatdate-time Link to this property Name string 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 RecordResponseOpenpgpkeyRecordSettings Settings for the DNS record.

IPV4Only boolOptional 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 IPV6Only boolOptional 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 \[]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: float64 Link to this property type TTL float64 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 RecordResponseOpenpgpkeyRecordType Record type. Link to this property CommentModifiedOn TimeOptional When the record comment was last modified. Omitted if there is no comment. formatdate-time Link to this property TagsModifiedOn TimeOptional When the record tags were last modified. Omitted if there are no tags. formatdate-time Link to this property

Link to this property

type RecordResponsePTRRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponsePTRRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseTXTRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseTXTRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseCAARecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseCAARecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseCERTRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseCERTRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseDNSKEYRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseDNSKEYRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseDSRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseDSRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseHTTPSRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseHTTPSRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseLOCRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseLOCRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseNAPTRRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseNAPTRRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseSMIMEARecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseSMIMEARecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseSRVRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseSRVRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseSSHFPRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseSSHFPRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseSVCBRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseSVCBRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseTLSARecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseTLSARecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

type RecordResponseURIRecord struct{…}

ID string Identifier. maxLength32 Link to this property CreatedOn Time When the record was created. formatdate-time Link to this property

Meta RecordResponseURIRecordMeta Extra Cloudflare-specific metadata about the record.

Link to this property

[Link to this property](<#(resource)%20dns.records%20%3E%20(model)%20record_response%20%3E%20(schema)>) ### List DNS Records Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/dns" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.DNS.Records.List(context.TODO(), dns.RecordListParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 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": [ { "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 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": [ { "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 } } ```