Virtual Private Cloud API, REST: Network.List
Retrieves the list of Network resources in the specified folder.
HTTP request
GET https://vpc.api.cloud.yandex.net/vpc/v1/networks
Query parameters
Field |
Description |
folderId |
string Required field. ID of the folder to list networks in. |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
filter |
string A filter expression that filters resources listed in the response.
|
Response
HTTP Code: 200 - OK
{
"networks": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"defaultSecurityGroupId": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
networks[] |
List of Network resources. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
Network
A Network resource. For more information, see Networks.
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 String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the network. |
description |
string Optional description of the network. 0-256 characters long. |
labels |
string Resource labels as |
defaultSecurityGroupId |
string ID of default security group for network. |