Перейти к основному содержимому
API docs by Redocly

Global Router API (v1.0.0)

Managing Global Router: organizing network connectivity between products and services, and between servers in different pools

Routers

Represents the core routing devices connecting networks across Services and Zones. Routers are the points where Networks are attached, and where Static Routes are applied to shape traffic between Zones and Services.

List routers

Returns a list of routers.

query Parameters
page
integer

The page number of the query results to be shown in the response. Default number is 1.

limit
integer

Number of elements on one page. Maximum number is 200. Default number is 20.

sort_keys
string

List of keys to sort results by. If there is more than one key, separate by comma, for example, id,name.

sort_direction
string

Sorting direction. Can be asc or desc. Default direction is asc.

filters
string

List of key values to filter results. If there is more than one key, separate by comma.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create router

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Request Body schema: application/json
required
name
string
tags
Array of strings <= 150 items

List of unique tags.

Responses

Request samples

Content type
application/json
{
  • "name": "Name",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "enabled": true,
  • "account_id": "string",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "netops_router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ],
  • "leak_uuid": "123e4567-e89b-12d3-a456-426655440000",
  • "prefix_pool_id": "123e4567-e89b-12d3-a456-426655440000",
  • "vpn_id": 1
}

Get router

path Parameters
router_id
required
string

Router identifier.

query Parameters
nested
boolean

Get information about a router and its nested networks, subnets, and static routes.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "enabled": true,
  • "account_id": "string",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "netops_router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ],
  • "leak_uuid": "123e4567-e89b-12d3-a456-426655440000",
  • "prefix_pool_id": "123e4567-e89b-12d3-a456-426655440000",
  • "vpn_id": 1
}

Update router

path Parameters
router_id
required
string

Router identifier.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Request Body schema: application/json
required
name
string
tags
Array of strings <= 150 items

List of unique tags.

Responses

Request samples

Content type
application/json
{
  • "name": "Name",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "enabled": true,
  • "account_id": "string",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "netops_router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ],
  • "leak_uuid": "123e4567-e89b-12d3-a456-426655440000",
  • "prefix_pool_id": "123e4567-e89b-12d3-a456-426655440000",
  • "vpn_id": 1
}

Delete router

path Parameters
router_id
required
string

Router identifier.

query Parameters
cascade
boolean

If true, the router will be deleted along with its nested networks, subnets and static routes in the Global Router service. If networks and subnets are from the vpc service, they will also be deleted from the cloud platform. Networks and subnets from other services will not be deleted from their source services.

disconnect
boolean

If true, only the router will be deleted along with its static routes. Connected network and subnets will not be deleted from their source services.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Networks

Defines logical networks allocated to products and services, enabling isolation and routing within the infrastructure. If a network is connected to a router, it exists in both Global Router service and its original service, and can be managed separately. For example, you can delete a cloud platform network in Global Router service without deleting it from the cloud platform, it will disconnect the cloud platform network from the router. Each network is created within a zone, can host multiple subnets, and is connected via a router.

Returns a list of global router networks.

query Parameters
page
integer

Number of the page to return. Default number is 1.

limit
integer

Number of elements on one page. Maximum number is 200. Default number is 20.

sort_keys
string

List of keys to sort results by. If there is more than one key, separate by comma, for example, id,name.

sort_direction
string

Sorting direction. Can be asc or desc. Default direction is asc.

filters
string

List of key values to filter results. If there is more than one key, separate by comma.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create network

Creates a network in the Global Router service. If the network belongs to the vpc service but doesn't exist on the cloud platform yet, it will also be created on the cloud platform. Networks from other services must be created in the source service beforehand; otherwise, they cannot be created in the Global Router service.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Request Body schema: application/json
required
name
string
vlan
integer [ 2 .. 4094 ]
router_id
required
string

Router identifier.

zone_id
required
string

Zone identifier.

vdc_name
string

VMware virtual data center name.

tags
Array of strings <= 150 items

List of unique tags.

inner_vlan
integer [ 2 .. 4094 ]

Q-in-Q tag to create VLAN segment, only available for networks in the dedicated service. To use Q-in-Q you have to enable it for the network, create a ticket for that.

os_network_id
string

Network identifier in the cloud platform.

Responses

Request samples

Content type
application/json
{
  • "name": "Name",
  • "vlan": 2,
  • "router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "zone_id": "123e4567-e89b-12d3-a456-426655440000",
  • "vdc_name": "string",
  • "tags": [
    ],
  • "inner_vlan": 2,
  • "os_network_id": "123e4567-e89b-12d3-a456-426655440000"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "vlan": 2,
  • "router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "zone_id": "123e4567-e89b-12d3-a456-426655440000",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "vdc_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "account_id": "string",
  • "sv_network_id": "123e4567-e89b-12d3-a456-426655440000",
  • "netops_vlan_uuid": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ],
  • "inner_vlan": 2,
  • "os_network_id": "123e4567-e89b-12d3-a456-426655440000"
}

Get network

path Parameters
network_id
required
string
header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "vlan": 2,
  • "router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "zone_id": "123e4567-e89b-12d3-a456-426655440000",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "vdc_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "account_id": "string",
  • "sv_network_id": "123e4567-e89b-12d3-a456-426655440000",
  • "netops_vlan_uuid": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ],
  • "inner_vlan": 2,
  • "os_network_id": "123e4567-e89b-12d3-a456-426655440000"
}

Change network

path Parameters
network_id
required
string
header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Request Body schema: application/json
required
name
string
tags
Array of strings <= 150 items

List of unique tags.

Responses

Request samples

Content type
application/json
{
  • "name": "Name",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "vlan": 2,
  • "router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "zone_id": "123e4567-e89b-12d3-a456-426655440000",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "vdc_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "account_id": "string",
  • "sv_network_id": "123e4567-e89b-12d3-a456-426655440000",
  • "netops_vlan_uuid": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ],
  • "inner_vlan": 2,
  • "os_network_id": "123e4567-e89b-12d3-a456-426655440000"
}

Delete network

path Parameters
network_id
required
string
query Parameters
cascade
boolean

If true, the network and its subnets will be deleted from the Global Router service. If the network is in the vpc service, the network and its subnets will also be deleted from the cloud platform.

disconnect
boolean

If true, the network an its subnets will be deleted from the Global Router service. The network and its subnets will not be deleted from their source services.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Subnets

Specifies subnetworks within a network — used to segment traffic, allocate IP ranges and manage routing in an L3 VPN context. Same as network, it exists in both Global Router service and its original service, and can be managed separately. Static routes may reference subnets as destinations.

List subnets

Returns a list of subnets.

query Parameters
page
integer

Number of the page to return. Default number is 1.

limit
integer

Number of elements on one page. Maximum number is 200. Default number is 20.

sort_keys
string

List of keys to sort results by. If there is more than one key, separate by comma, for example, id,name.

sort_direction
string

Sorting direction. Can be asc or desc. Default direction is asc.

filters
string

List of key values to filter results. If there is more than one key, separate by comma.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create subnet

Creates a subnet in the Global Router service. If the subnet belongs to the vpc service but doesn't exist on the cloud platform yet, it will also be created on the cloud platform. Subnets from other services must be created in the source service beforehand; otherwise, they cannot be created in the Global Router service.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Request Body schema: application/json
required
name
string
gateway
string

Subnet IP address that will be used as gateway on the router. This IP address must be available. If not specified, the first IP address in subnet range will be used.

cidr
required
string

Subnet IP address range in CIDR notation.

network_id
required
string

Parent network identifier in the Global Router service.

service_addresses
Array of strings = 2 items

Two of the subnet IP addresses that will be reserved as service ones. These IP addresses must be available. If not specified, the last two IP addresses in subnet range will be reserved.

tags
Array of strings <= 150 items

List of unique tags.

os_subnet_id
string

Subnet identifier in the cloud platform.

Responses

Request samples

Content type
application/json
{
  • "name": "Name",
  • "gateway": "192.168.0.1",
  • "cidr": "192.168.0.0/24",
  • "network_id": "123e4567-e89b-12d3-a456-426655440000",
  • "service_addresses": [
    ],
  • "tags": [
    ],
  • "os_subnet_id": "123e4567-e89b-12d3-a456-426655440000"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "gateway": "192.168.0.1",
  • "cidr": "192.168.0.0/24",
  • "network_id": "123e4567-e89b-12d3-a456-426655440000",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "account_id": "string",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "service_addresses": [
    ],
  • "sv_subnet_id": "123e4567-e89b-12d3-a456-426655440000",
  • "netops_subnet_id": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ],
  • "os_subnet_id": "123e4567-e89b-12d3-a456-426655440000"
}

Get subnet

path Parameters
subnet_id
required
string
header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "gateway": "192.168.0.1",
  • "cidr": "192.168.0.0/24",
  • "network_id": "123e4567-e89b-12d3-a456-426655440000",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "account_id": "string",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "service_addresses": [
    ],
  • "sv_subnet_id": "123e4567-e89b-12d3-a456-426655440000",
  • "netops_subnet_id": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ],
  • "os_subnet_id": "123e4567-e89b-12d3-a456-426655440000"
}

Change subnet

path Parameters
subnet_id
required
string
header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Request Body schema: application/json
required
name
string
tags
Array of strings <= 150 items

List of unique tags.

Responses

Request samples

Content type
application/json
{
  • "name": "Name",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "gateway": "192.168.0.1",
  • "cidr": "192.168.0.0/24",
  • "network_id": "123e4567-e89b-12d3-a456-426655440000",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "account_id": "string",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "service_addresses": [
    ],
  • "sv_subnet_id": "123e4567-e89b-12d3-a456-426655440000",
  • "netops_subnet_id": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ],
  • "os_subnet_id": "123e4567-e89b-12d3-a456-426655440000"
}

Delete subnet

path Parameters
subnet_id
required
string
query Parameters
cascade
boolean

The subnet will be deleted from the Global Router service along with static routes that use subnet IP addresses as next hops. If the subnet is in the vpc service, it will also be deleted from the cloud platform.

disconnect
boolean

The subnet will be deleted from the Global Router service along with static routes that use subnet IP addresses as next hops. The subnet will not be deleted from its source service.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Static routes

Captures manually configured routing entries used to direct traffic between networks and zones via specific addresses.

List static routes

Returns a list of static routes.

query Parameters
page
integer

Number of the page to return. Default number is 1.

limit
integer

Number of elements on one page. Maximum number is 200. Default number is 20.

sort_keys
string

List of keys to sort results by. If there is more than one key, separate by comma, for example, id,name.

sort_direction
string

Sorting direction. Can be asc or desc. Default direction is asc.

filters
string

List of key values to filter results. If there is more than one key, separate by comma.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create static route

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Request Body schema: application/json
required
name
string
cidr
required
string

Destination subnet to which you want to direct traffic. Must be subnet IP address range in CIDR notation.

next_hop
required
string

IP address in a subnet through which traffic will be routed to the destination subnet. The IP address must belong to one of the subnets connected to the router.

router_id
required
string

Router identifier.

tags
Array of strings <= 150 items

List of unique tags.

Responses

Request samples

Content type
application/json
{
  • "name": "Name",
  • "cidr": "192.168.0.0/24",
  • "next_hop": "192.168.0.1",
  • "router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "cidr": "192.168.0.0/24",
  • "next_hop": "192.168.0.1",
  • "router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "account_id": "string",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "subnet_id": "123e4567-e89b-12d3-a456-426655440000",
  • "netops_static_route_id": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ]
}

Get static route

path Parameters
static_route_id
required
string
header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "cidr": "192.168.0.0/24",
  • "next_hop": "192.168.0.1",
  • "router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "account_id": "string",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "subnet_id": "123e4567-e89b-12d3-a456-426655440000",
  • "netops_static_route_id": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ]
}

Change static route

path Parameters
static_route_id
required
string
header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Request Body schema: application/json
required
name
string
tags
Array of strings <= 150 items

List of unique tags.

Responses

Request samples

Content type
application/json
{
  • "name": "Name",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426655440000",
  • "name": "Name",
  • "cidr": "192.168.0.0/24",
  • "next_hop": "192.168.0.1",
  • "router_id": "123e4567-e89b-12d3-a456-426655440000",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "IMMUTABLE",
  • "account_id": "string",
  • "project_id": "123e4567e89b12d3a456426655440000",
  • "subnet_id": "123e4567-e89b-12d3-a456-426655440000",
  • "netops_static_route_id": "123e4567-e89b-12d3-a456-426655440000",
  • "tags": [
    ]
}

Delete route

path Parameters
static_route_id
required
string
header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Services

Represents a scope of products and services using the same network infrastructure. For example, the vpc service represents cloud servers, load balancers, file storage, Managed Kubernetes and managed databases.

List services

query Parameters
page
integer

Number of the page to return. Default number is 1.

limit
integer

Number of elements on one page. Maximum number is 200. Default number is 20.

sort_keys
string

List of keys to sort results by. If there is more than one key, separate by comma, for example, id,name.

sort_direction
string

Sorting direction. Can be asc or desc. Default direction is asc.

filters
string

List of key values to filter results. If there is more than one key, separate by comma.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Zones

Represents a logical grouping of network resources that are used by a service or a product within one pool. For example, cloud platform networks in the pool ru-3 belong to the zone ru-3. Zones are logically aggregated into Zone Groups.

List zones

query Parameters
show_groups
boolean

If true, the information about zone groups will also be shown in response.

page
integer

Number of the page to return. Default number is 1.

limit
integer

Number of elements on one page. Maximum number is 200. Default number is 20.

sort_keys
string

List of keys to sort results by. If there is more than one key, separate by comma, for example, id,name.

sort_direction
string

Sorting direction. Can be asc or desc. Default direction is asc.

filters
string

List of key values to filter results. If there is more than one key, separate by comma.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Zone groups

Logical association of zones. A router can only connect networks of the same zone group.

List zone groups

query Parameters
show_zones
boolean

If true, the information about zones in groups will also be shown in response.

page
integer

Number of the page to return. Default number is 1.

limit
integer

Number of elements on one page. Maximum number is 200. Default number is 20.

sort_keys
string

List of keys to sort results by. If there is more than one key, separate by comma, for example, id,name.

sort_direction
string

Sorting direction. Can be asc or desc. Default direction is asc.

filters
string

List of key values to filter results. If there is more than one key, separate by comma.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Quotas

Provides quotas for resources (routers, networks, subnets, static routes) within the Global Router service.

List quotas

query Parameters
page
integer

Number of the page to return. Default number is 1.

limit
integer

Number of elements on one page. Maximum number is 200. Default number is 20.

sort_keys
string

List of keys to sort results by. If there is more than one key, separate by comma, for example, id,name.

sort_direction
string

Sorting direction. Can be asc or desc. Default direction is asc.

filters
string

List of key values to filter results. If there is more than one key, separate by comma.

header Parameters
Accept-Language
string

Sets language for error responses. Can be 'ru' or 'en'.

X-Request-ID
string

Sets req-id for request. Must be a valid UUID v4 string. If not provided, will be generated automatically.

Responses

Response samples

Content type
application/json
[
  • {
    }
]