Skip to content

Get DNS Zone by name

POST
/enum.api.v1.DnsService/GetZoneByName
object
projectId
string
name
string

OK

object
zone
object
id
string
projectId
string
name

Apex domain name (e.g. example.com).

string
verifiedAt

Set once ownership is proven and the zone is served.

string format: date-time
nameservers

Nameservers to set at the registrar to delegate the zone. Assigned per zone and stable for its lifetime; other zones may be assigned a different pair.

Array<string>
createdAt
string format: date-time
updatedAt
string format: date-time
status
integer format: enum
deletionProtected

When true, the zone cannot be deleted until unprotected.

boolean
dnssec

DNSSEC status when online signing is enabled.

object
enabled
boolean
algorithm
string
ds

DS records for registrar handoff (presentation format).

Array<string>
dsPublished
boolean
dsPublishedAt
string format: date-time
dnskey

Zone signing keys in DNSKEY presentation format (“flag protocol algorithm public_key”), for registrars that take a key instead of a DS digest.

Array<string>
observedNameservers

Nameservers the domain is currently delegated to at its registrar, as last observed. Compare against nameservers to see whether delegation is in place.

Array<string>