Contact UsGet started

Virtual Private Cloud API, REST: Network methods

Written by
Updated at June 28, 2024

A set of methods for managing Network resources.

JSON Representation

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "defaultSecurityGroupId": "string"
}
Field Description
id string

ID of the network.
folderId string

ID of the folder that the network 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 network. The name is 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 network. 0-256 characters long.
labels object

Resource 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]*.
defaultSecurityGroupId string

ID of default security group for network.

Methods

Method Description
create Creates a network in the specified folder using the data specified in the request. Method starts an asynchronous operation that can be cancelled while it is in progress.
delete Deletes the specified network.
get Returns the specified Network resource.
list Retrieves the list of Network resources in the specified folder.
listOperations Lists operations for the specified network.
listRouteTables Lists route tables from the specified network.
listSecurityGroups Lists security groups from the specified network.
listSubnets Lists subnets from the specified network.
move Move network to another folder.
update Updates the specified network. Method starts an asynchronous operation that can be cancelled while it is in progress.
Previous
update
Next
create