Cloud DNS API, REST: DnsZone.get
Returns the specified DNS zone.
To get the list of all available DNS zones, make a list request.
HTTP request
GET https://dns.api.cloud.yandex.net/dns/v1/zones/{dnsZoneId}
Path parameters
| Parameter | Description |
|---|---|
| dnsZoneId | Required. ID of the DNS zone to return. To get a DNS zone ID, make a list request. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"zone": "string",
"privateVisibility": {
"networkIds": [
"string"
]
},
"publicVisibility": {},
"deletionProtection": true
}
A DNS zone. For details about the concept, see DNS zones.
| Field | Description |
|---|---|
| id | string ID of the DNS zone. Generated at creation time. |
| folderId | string ID of the folder that the DNS zone belongs to. |
| createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
| name | string Name of the DNS zone. The name is unique within the folder. |
| description | string Description of the DNS zone. |
| labels | object DNS zone labels as |
| zone | string DNS zone suffix. |
| privateVisibility | object Privately visible zone settings. Specifies whether records within the zone are visible from a VPC networks only. Configuration for privately visible zones. |
| privateVisibility. networkIds[] |
string Network IDs. The number of elements must be in the range 0-100. The string length in characters for each value must be equal to 20. |
| publicVisibility | object Publicly visible zone settings. Indicates whether records within the zone are publicly visible. Configuration for publicly visible zones. |
| deletionProtection | boolean (boolean) Prevents accidental zone removal. |