Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
© 2022 Yandex.Cloud LLC
Yandex Cloud DNS
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Zones
      • Creating an internal DNS zone
      • Creating a public DNS zone
      • Updating a DNS zone
      • Deleting a DNS zone
    • Records
      • Creating a record
      • Updating a record
      • Deleting a record
  • Concepts
    • Overview
    • DNS zones
    • Resource records
    • Integration with Yandex Compute Cloud
    • Quotas and limits
  • Practical guidelines
    • Configuring a local caching DNS resolver
    • Migrating DNS zones from Yandex 360
    • Integrating with a corporate DNS service
    • Configuring Cloud DNS for access to managed database clusters from other cloud networks
    • Creating an ACME resolver webhook for responses to DNS01 checks
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • DnsZoneService
      • OperationService
    • REST
      • Overview
      • DnsZone
        • Overview
        • create
        • delete
        • get
        • getRecordSet
        • list
        • listAccessBindings
        • listOperations
        • listRecordSets
        • setAccessBindings
        • update
        • updateAccessBindings
        • updateRecordSets
        • upsertRecordSets
  • Questions and answers
  1. API reference
  2. REST
  3. DnsZone
  4. get

Method get

Written by
Yandex Cloud
  • HTTP request
  • Path parameters
  • Response

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": {}
}

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.

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 key:value pairs.

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-10. 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.

Was the article helpful?

Language / Region
© 2022 Yandex.Cloud LLC
In this article:
  • HTTP request
  • Path parameters
  • Response