v1

latestOpenAPI 3.1.02026-07-244861122.7 KB

records

List DNS names in a zone

Lists the dns names of the user in a given zone. Results can be sorted using the sort parameter, and filtered by name metadata using metadata filter expressions.

get/v1/dns/records/{zone_name}

Path parameters

zone_namestring required

The name of the zone.

Example:example.com

The name of the zone.

Query parameters

offsetinteger

Offset from beginning of list

limitinteger

Maximum number of results to return

name'asc' | 'desc'

name_labels_reversed'asc' | 'desc'

created_at'asc' | 'desc'

Sort options: (allowed fields: name, name_labels_reversed, created_at; allowed sorting: asc, desc).

{
  "name": "asc",
  "name_labels_reversed": "asc",
  "created_at": "asc"
}

expand[]string[]

Sub-resource expansion options. (allowed resources: offline_settings)

[
  "offline_settings"
]

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

success

Example response

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