v1

latestOpenAPI 3.1.02026-07-244861122.7 KB

records

List RRSets for a name

Lists the rrsets for a name. Results can be filtered and sorted using the filter and sort parameters, and filtered by rrset metadata using metadata filter expressions.

get/v1/dns/records/{zone_name}/{name}/rrsets

Path parameters

zone_namestring required

The name of the zone.

Example:example.com

The name of the zone.

namestring required

The DNS name, not including the zone portion.

Example:dns-name

The DNS name, not including the zone portion.

Query parameters

offsetinteger

Offset from beginning of list

limitinteger

Maximum number of results to return

dns_type'asc' | 'desc'

Sort options: (allowed fields: dns_type; allowed sorting: asc, desc).

{
  "dns_type": "asc"
}

metadatastring

A metadata filter expression See metadata filters for an in-depth description of the expression syntax.

Example:{"or":[{"and":[{"op":"contains","key":"key1","value":"value1"},{"op":"exact","key":"key2","value":"value2"}]},{"op":"exact","key":"key3","value":"value3"}]}

Filter results by metadata. See metadata filters for an in-depth description of the expression syntax.

Response

A list of Resource Record Sets

Example response

{
  "data": [
    {
      "metadata": {
        "public property": "public value"
      }
    }
  ],
  "page": {
    "total": 10
  }
}