Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

Virtual Private Cloud API, gRPC: PrivateEndpointService.Get

Written by
Updated at June 18, 2026
View in Markdown

Returns the specified Private Endpoint resource.
To get the list of all available PrivateEndpoint resources, make a List
request.

gRPC request

rpc Get (GetPrivateEndpointRequest) returns (PrivateEndpoint)

GetPrivateEndpointRequest

{
  "private_endpoint_id": "string"
}

Field

Description

private_endpoint_id

string

ID of the PrivateEndpoint resource to return.
To get PrivateEndpoint resource ID make a PrivateEndpointService.List
request.
The length must be less than or equal to 50.
This field is required.

PrivateEndpoint

{
  "id": "string",
  "folder_id": "string",
  "created_at": "google.protobuf.Timestamp",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "network_id": "string",
  "status": "Status",
  "address": {
    "subnet_id": "string",
    "address": "string",
    "address_id": "string"
  },
  "dns_options": {
    "private_dns_records_enabled": "bool"
  },
  // Includes only one of the fields `object_storage`, `service_name`
  "object_storage": "ObjectStorage",
  "service_name": "string",
  // end of the list of possible fields
  "dns_records": [
    {
      "name": "string"
    }
  ]
}

Field

Description

id

string

ID of the private endpoint. Generated at creation time.

folder_id

string

ID of the folder that the private endpoint belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the private endpoint.
The name is unique within the folder.
Value must match the regular expression
``\

a-zA-Z?``.

description

string

Description of the private endpoint. 0-256 characters long.

labels

object (map<string, string>)

Private endpoint labels as key:value pairs.
No more than 64 per resource.
The maximum string length in characters for each value is 63.
Each value must match the regular expression [-_0-9a-z]*.
The string length in characters for each key must be 1-63.
Each key must match the regular expression [a-z][-_0-9a-z]*.

network_id

string

ID of the network that the private endpoint belongs to.

status

enum Status

Status of the private endpoint.

  • PENDING: Private endpoint is still creating / updating.
  • AVAILABLE: Private endpoint is available.
  • DELETING: Private endpoint is deleting.

address

EndpointAddress

Private endpoint ip address details.

dns_options

DnsOptions

Private endpoint dns options.

object_storage

ObjectStorage

Yandex Cloud Object Storage.

Includes only one of the fields object_storage, service_name.

Service to connect with via private endpoint.

service_name

string

Yandex Cloud service name.

Includes only one of the fields object_storage, service_name.

Service to connect with via private endpoint.

dns_records[]

DnsRecord

List of private endpoint dns records.

EndpointAddress

Private endpoint ip address details.

Field

Description

subnet_id

string

ID of the subnet that the private endpoint address belongs to.

address

string

IP address of the private endpoint.

address_id

string

ID of the private endpoint address.

DnsOptions

Field

Description

private_dns_records_enabled

bool

If enabled - vpc will create private dns records for specified service.

ObjectStorage

Yandex Cloud Object Storage.

Field

Description

Empty

DnsRecord

Field

Description

name

string

Name of the dns record.
Previous
Overview
Next
List