v1

latestSwagger 2.02026-08-041113661.2 MB
ZoneService

Get zone

get/v1beta/dns/zones/{name}

Path parameters

namestring required

Name of the domain to which DNS zone corresponds

Query parameters

idstring

DNS zone ID.

with_recordsboolean

Indicates, whether DNS records should be displayed in output.

with_historyboolean

Indicates, whether DNS zone history should be displayed in output.

with_dnskeyboolean

Indicates, whether DNSSEC keys should be displayed in output.

providerstring

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

Response

A successful response.

codeinteger
descstring
maintenanceboolean

Example response

{
  "code": 0,
  "data": {
    "active": true,
    "creation_date": "2012-02-05 7:37:28",
    "dnskey": "",
    "history": [
      {
        "date": "2019-06-19 17:40:09",
        "is": true,
        "source": "",
        "was": ""
      }
    ],
    "id": 12345,
    "ip": "127.0.0.1",
    "is_deleted": false,
    "is_shadow": false,
    "is_spamexperts_enabled": false,
    "modification_date": "2018-11-28 6:57:05",
    "name": "domain.com",
    "premium_dns": {
      "sectigo": {
        "autorenew": false,
        "order_date": "2021-08-05 7:37:28",
        "renewal_date": "2022-11-28 6:57:05",
        "secured": false,
        "website_id": 123456
      }
    },
    "provider": "sectigo",
    "records": [
      {
        "creation_date": "",
        "ip": "127.0.0.1",
        "modification_date": "",
        "name": "domain.com",
        "prio": 1,
        "ttl": 900,
        "type": "CNAME",
        "value": "abcd.domain.com"
      }
    ],
    "reseller_id": 123456,
    "type": "master"
  },
  "desc": ""
}