Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Cloud DNS
  • Getting started
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • GetRecordSet
        • ListRecordSets
        • UpdateRecordSets
        • UpsertRecordSets
        • ListOperations
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
        • UpdatePrivateNetworks
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • FAQ

In this article:

  • gRPC request
  • GetDnsZoneRequest
  • DnsZone
  • PrivateVisibility
  • PublicVisibility
  1. API reference
  2. gRPC
  3. DnsZone
  4. Get

Cloud DNS API, gRPC: DnsZoneService.Get

Written by
Yandex Cloud
Updated at December 17, 2024
  • gRPC request
  • GetDnsZoneRequest
  • DnsZone
  • PrivateVisibility
  • PublicVisibility

Returns the specified DNS zone.

To get the list of all available DNS zones, make a List request.

gRPC requestgRPC request

rpc Get (GetDnsZoneRequest) returns (DnsZone)

GetDnsZoneRequestGetDnsZoneRequest

{
  "dns_zone_id": "string"
}

Field

Description

dns_zone_id

string

Required field. ID of the DNS zone to return.

To get a DNS zone ID, make a DnsZoneService.List request.

DnsZoneDnsZone

{
  "id": "string",
  "folder_id": "string",
  "created_at": "google.protobuf.Timestamp",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "zone": "string",
  "private_visibility": {
    "network_ids": [
      "string"
    ]
  },
  "public_visibility": "PublicVisibility",
  "deletion_protection": "bool"
}

A DNS zone. For details about the concept, see DNS zones.

Field

Description

id

string

ID of the DNS zone. Generated at creation time.

folder_id

string

ID of the folder that the DNS zone belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the DNS zone.
The name is unique within the folder.

description

string

Description of the DNS zone.

labels

object (map<string, string>)

DNS zone labels as key:value pairs.

zone

string

DNS zone suffix.

private_visibility

PrivateVisibility

Privately visible zone settings.
Specifies whether records within the zone are visible from a VPC networks only.

public_visibility

PublicVisibility

Publicly visible zone settings.
Indicates whether records within the zone are publicly visible.

deletion_protection

bool

Prevents accidental zone removal.

PrivateVisibilityPrivateVisibility

Configuration for privately visible zones.

Field

Description

network_ids[]

string

Network IDs.

PublicVisibilityPublicVisibility

Configuration for publicly visible zones.

Field

Description

Empty

Was the article helpful?

Previous
Overview
Next
List
© 2025 Direct Cursus Technology L.L.C.