Get DNS Zone

POST

/enum.api.v1.DnsService/GetZone

Authorizations

• bearerAuth

Request Body ^required

object

projectId

string

id

string

Responses

200

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

string format: enum

Allowed values: RESOURCE_STATUS_UNSPECIFIED RESOURCE_STATUS_PROVISIONING RESOURCE_STATUS_READY RESOURCE_STATUS_FAILED RESOURCE_STATUS_DELETING

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>

400

invalid_argument: a field is missing or invalid.

Messages:

• validation error: <field>: <reason>

object

code

Error code, such as invalid_argument or not_found.

string

message

Human-readable error message.

string

401

unauthenticated: the token is missing, invalid, or expired.

Messages:

• missing authorization header
• invalid authorization header format
• authentication failed

object

code

Error code, such as invalid_argument or not_found.

string

message

Human-readable error message.

string

403

permission_denied: the token has no access to this project or method.

Messages:

• not authorized

object

code

Error code, such as invalid_argument or not_found.

string

message

Human-readable error message.

string

404

not_found: the resource does not exist.

Messages:

• resource not found

object

code

Error code, such as invalid_argument or not_found.

string

message

Human-readable error message.

string

429

resource_exhausted: the token’s rate limit is reached.

Messages:

• rate limit exceeded: wait for the number of seconds in Retry-After.

object

code

Error code, such as invalid_argument or not_found.

string

message

Human-readable error message.

string

500

internal: something failed on our side.

Messages:

• internal error

object

code

Error code, such as invalid_argument or not_found.

string

message

Human-readable error message.

string