Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Virtual Private Cloud API, REST: RouteTable.Update

Written by
Updated at January 14, 2025

Updates the specified route table.
Method starts an asynchronous operation that can be cancelled while it is in progress.

HTTP request

PATCH https://vpc.api.cloud.yandex.net/vpc/v1/routeTables/{routeTableId}

Path parameters

Field

Description

routeTableId

string

Required field. ID of the RouteTable resource to update.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "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"
    }
  ]
}

Field

Description

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

name

string

Name of the route table.
The name must be unique within the folder.

description

string

Description of the route table.

labels

object (map<string, string>)

Resource labels as key:value pairs.

staticRoutes[]

StaticRoute

List of static routes.

StaticRoute

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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "routeTableId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "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"
      }
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

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

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

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

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateRouteTableMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

RouteTable

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateRouteTableMetadata

Field

Description

routeTableId

string

ID of the RouteTable resource that is being updated.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

RouteTable

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.

StaticRoute

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.
Previous
Create
Next
Delete