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
  • Query parameters
  • Response
  • RouteTable
  • StaticRoute
  1. API reference
  2. REST
  3. RouteTable
  4. List

Virtual Private Cloud API, REST: RouteTable.List

Written by
Yandex Cloud
Updated at December 17, 2024
  • HTTP request
  • Query parameters
  • Response
  • RouteTable
  • StaticRoute

Retrieves the list of RouteTable resources in the specified folder.

HTTP requestHTTP request

GET https://vpc.api.cloud.yandex.net/vpc/v1/routeTables

Query parametersQuery parameters

Field

Description

folderId

string

Required field. ID of the folder that the route table belongs to.
To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListRouteTablesResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests. Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListRouteTablesResponse.nextPageToken returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The field name. Currently you can use filtering only on RouteTable.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

ResponseResponse

HTTP Code: 200 - OK

{
  "routeTables": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "networkId": "string",
      "staticRoutes": [
        {
          // Includes only one of the fields `destinationPrefix`
          "destinationPrefix": "string",
          // end of the list of possible fields
          // Includes only one of the fields `nextHopAddress`, `gatewayId`
          "nextHopAddress": "string",
          "gatewayId": "string",
          // end of the list of possible fields
          "labels": "object"
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

Field

Description

routeTables[]

RouteTable

List of RouteTable resources.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListRouteTablesRequest.pageSize, use
the nextPageToken as the value
for the ListRouteTablesRequest.pageToken query parameter
in the next list request. Subsequent list requests will have their own
nextPageToken to continue paging through the results.

RouteTableRouteTable

A RouteTable resource. For more information, see Static Routes.

Field

Description

id

string

ID of the route table.

folderId

string

ID of the folder that the route table belongs to.

createdAt

string (date-time)

Creation timestamp in RFC3339 text format.

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 route table.
The name must be unique within the folder.
Value must match the regular expression \|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description

string

Optional description of the route table. 0-256 characters long.

labels

object (map<string, string>)

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

networkId

string

ID of the network the route table belongs to.

staticRoutes[]

StaticRoute

List of static routes.

StaticRouteStaticRoute

A StaticRoute resource. For more information, see Static Routes.

Field

Description

destinationPrefix

string

Destination subnet in CIDR notation

Includes only one of the fields destinationPrefix.

nextHopAddress

string

Next hop IP address

Includes only one of the fields nextHopAddress, gatewayId.

gatewayId

string

Next hop gateway id

Includes only one of the fields nextHopAddress, gatewayId.

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.

Was the article helpful?

Previous
Get
Next
Create
Yandex project
© 2025 Yandex.Cloud LLC