Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Get DNS zone

Used to get a DNS zone

For managed zones this call is als available on the url /v2/domains/domainName/zone
  • GETMethod
  • /v2/dns/zones/zoneIdURL
URL fields
Name Type Description Restrictions
zoneId Integer The DNS zone ID
Request parameters
Name Type Required / Optional Description Restrictions
fields String Optional Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.

Successful request

DNS zone has been retrieved successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
id Integer Required The DNS zone ID
name String Optional Name of the DNS zone
customer String Required The customer handle
createdDate Timestamp Required The date the zone was created
updatedDate Timestamp Optional The date the zone was last updated
deletionDate Timestamp Optional The date the (previously managed) zone will be removed
managed Boolean Required Whether or not the zone is manage trough the domain
service Enum Required

Possible values:

  • BASIC: Basic, free DNS
  • PREMIUM: Premium DNS
template String Optional Name of the template the zone is linked to
master String Optional IP address of the (hidden) master
ns List <String> Optional List of name servers for the DNS zone
hostMaster String Required The email address of the hostmaster
refresh Integer Required The time when the slave will try to refresh the zone from the master, in seconds
retry Integer Required The time between retries if the slave (secondary) fails to contact the master when refresh has expired, in seconds
expire Integer Required Indicates when the zone data is no longer authoritative, in seconds
ttl Integer Required The duration that the record may be cached, in seconds
dnssec Boolean Required Whether or not DNSSEC is enabled
defaultRecords List < defaultRecords > Required Default DNS records
records List < records > Optional DNS records
keyData List < keyData > Optional DNSSEC Key data for domain
defaultRecords
Name Type Required / Optional Description
name String Required The full record name.
type Enum Required The record type

Possible values:

  • A: Address record
  • MX: Mail exchange record
  • CNAME: Canonical name record
  • AAAA: IPv6 address record
  • URL: URL Record
  • MBOXFW: Mailbox forward record
  • HINFO: Host information record
  • NAPTR: Naming Authority Pointer
  • NS: Name server record
  • SRV: Service locator
  • CAA: Certification Authority Authorization
  • TLSA: Transport Layer Security Authentication
  • ALIAS: ALIAS record
  • TXT: Text record
  • SOA: Start of [a zone of] authority record
  • DNSKEY: DNSKEY record
  • CERT: Certificate record
  • DS: DS record
  • LOC: Location record
  • SSHFP: SSH key record
  • URI: URI record
content String Required Type specific content of the record
ttl Integer Required The duration that the record may be cached, in seconds
prio Integer Optional The priority, mandatory if "type" is MX or SRV
records
Name Type Required / Optional Description
name String Required The full record name.
type Enum Required The record type

Possible values:

  • A: Address record
  • MX: Mail exchange record
  • CNAME: Canonical name record
  • AAAA: IPv6 address record
  • URL: URL Record
  • MBOXFW: Mailbox forward record
  • HINFO: Host information record
  • NAPTR: Naming Authority Pointer
  • NS: Name server record
  • SRV: Service locator
  • CAA: Certification Authority Authorization
  • TLSA: Transport Layer Security Authentication
  • ALIAS: ALIAS record
  • TXT: Text record
  • SOA: Start of [a zone of] authority record
  • DNSKEY: DNSKEY record
  • CERT: Certificate record
  • DS: DS record
  • LOC: Location record
  • SSHFP: SSH key record
  • URI: URI record
content String Required Type specific content of the record
ttl Integer Required The duration that the record may be cached, in seconds
prio Integer Optional The priority, mandatory if "type" is MX or SRV
keyData
Name Type Required / Optional Description
protocol Integer Required The DNSSEC protocol

Possible values:

  • 3
flags Integer Required The DNSSEC flags

Possible values:

  • 256: 256 (ZSK)
  • 257: 257 (KSK)
algorithm Integer Required The DNSSEC algorithm

Possible values:

  • 3: 3 (DSA/SHA1)
  • 5: 5 (RSA/SHA-1)
  • 6: 6 (DSA-NSEC3-SHA1)
  • 7: 7 (RSASHA1-NSEC3-SHA1)
  • 8: 8 (RSA/SHA-256)
  • 10: 10 (RSA/SHA-512)
  • 12: 12 (GOST R 34.10-2001)
  • 13: 13 (ECDSA Curve P-256 with SHA-256)
  • 14: 14 (ECDSA Curve P-384 with SHA-384)
  • 15: 15 (Ed25519)
  • 16: 16 (Ed448)
  • 17: 17 (SM2 signing algorithm with SM3 hashing algorithm)
  • 23: 23 (GOST R 34.10.2012)
publicKey String Required The base64 encoded public key

Failed requests

Generic errors can be expected.

URL fields
The DNS zone ID
Request parameters
Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.
Request

GET /v2/dns/zones/zoneId

Response