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
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Virtual Private Cloud
  • Getting started
  • DDoS Protection
  • Access management
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • ListOperations
        • Move
  • Audit Trails events
  • Release notes
  • FAQ

In this article:

  • HTTP request
  • Path parameters
  • Response
  1. API reference
  2. REST
  3. Gateway
  4. Get

Virtual Private Cloud API, REST: Gateway.Get

Written by
Yandex Cloud
Updated at December 17, 2024
  • HTTP request
  • Path parameters
  • Response

Returns the specified Gateway resource.

To get the list of all available Gateway resources, make a List request.

HTTP requestHTTP request

GET https://vpc.api.cloud.yandex.net/vpc/v1/gateways/{gatewayId}

Path parametersPath parameters

Field

Description

gatewayId

string

Required field. ID of the Gateway resource to return.

To get Gateway resource ID make a GatewayService.List request.

ResponseResponse

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  // Includes only one of the fields `sharedEgressGateway`
  "sharedEgressGateway": "object"
  // end of the list of possible fields
}

A Gateway resource. For more information, see Gateway.

Field

Description

id

string

ID of the gateway. Generated at creation time.

folderId

string

ID of the folder that the gateway belongs to.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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 gateway.
The name is unique within the folder.
Value must match the regular expression \\|[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

description

string

Description of the gateway. 0-256 characters long.

labels

object (map<string, string>)

Gateway 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]*.

sharedEgressGateway

object

Includes only one of the fields sharedEgressGateway.

Gateway specification

Was the article helpful?

Previous
Overview
Next
List
Yandex project
© 2025 Yandex.Cloud LLC