v1

latestOpenAPI 3.1.02026-07-244861122.7 KB

records

List DNS names

Lists the dns names of the user. The type of the results can be selected using the view parameter. Results can be filtered and sorted using the filter and sort parameters, and filtered by zone, name and rrset metadata using metadata filter expressions.

get/v1/dns/records

Query parameters

view'summary' | 'record'

Record format (defaults to summary)

Example:summary

Record format (defaults to summary)

offsetinteger

Offset from beginning of list

limitinteger

Maximum number of results to return

zone_name'asc' | 'desc'

name'asc' | 'desc'

name_labels_reversed'asc' | 'desc'

dns_type'asc' | 'desc'

rdata'asc' | 'desc'

label'asc' | 'desc'

zone_is_shared'asc' | 'desc'

created_at'asc' | 'desc'

Sort options: (allowed fields: zone_name, name, name_labels_reversed, dns_type, rdata, label, zone_is_shared, created_at; allowed sorting: asc, desc).

{
  "zone_name": "asc",
  "name": "asc",
  "name_labels_reversed": "asc",
  "dns_type": "asc",
  "rdata": "asc",
  "label": "asc",
  "zone_is_shared": "asc",
  "created_at": "asc"
}

zone_is_sharedboolean nullable

dynupdateboolean nullable

Filter options: (allowed fields: name, zone_name, dns_type, zone_is_shared, dynupdate)

{
  "dns_name": [
    "www"
  ],
  "zone_name": [
    "example-zone-a.com",
    "example-zone-b.com"
  ],
  "dns_type": [
    "A"
  ],
  "zone_is_shared": true,
  "update_group": [
    "dns-group-1"
  ],
  "dynupdate": true,
  "label": [
    "rdata-label"
  ],
  "rdata": [
    "192.0.2.1"
  ]
}

expand[]string[]

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

[
  "offline_settings"
]

zone_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 zone metadata. See metadata filters for an in-depth description of the expression syntax.

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 DNS name metadata. See metadata filters for an in-depth description of the expression syntax.

rrset_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 RRSet metadata. See metadata filters for an in-depth description of the expression syntax.

Response

DNS name data

Example response

{
  "data": [
    {
      "fqdn": "h.free.example.com"
    }
  ],
  "page": {
    "total": 10
  }
}