v1

latestSwagger 2.02026-08-041113661.2 MB
ZoneRecordService

List zone records

get/v1beta/dns/zones/{name}/records

Path parameters

namestring required

DNS record name

Query parameters

zone_idinteger

DNS zone ID.

limitinteger

How many records to retrieve (default: 100, max 500).

offsetinteger

From which record to retrieve (default: 0).

order_by.typestring

Sorting type (asc/desc).

order_by.namestring

Sorting type (asc/desc).

order_by.valuestring

Sorting type (asc/desc).

order_by.ttlstring

Sorting type (asc/desc).

order_by.priostring

Sorting type (asc/desc).

record_name_patternstring

DNS record name pattern. Wildcard (*) can be used.

value_patternstring

DNS record value pattern. Wildcard (*) can be used.

typestring

DNS record type.

priointeger

DNS record priority.

ttlinteger

DNS record TTL.

zone_providerstring

Name of the DNS provider. Set zone_provider=sectigo in case of only sectigo premium DNS zone records should be retrieved.

Response

A successful response.

codeinteger
descstring
maintenanceboolean

Example response

{
  "code": 0,
  "data": {
    "results": [
      {
        "creation_date": "",
        "ip": "127.0.0.1",
        "modification_date": "",
        "name": "domain.com",
        "prio": 1,
        "ttl": 900,
        "type": "CNAME",
        "value": "abcd.domain.com"
      }
    ],
    "total": 6
  },
  "desc": ""
}