Skip to main content
GET
/
cloud
/
v1
/
availablenetworks
/
{project_id}
/
{region_id}
List networks with subnets details
curl --request GET \
  --url https://api.gcore.com/cloud/v1/availablenetworks/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "results": [
    {
      "created_at": "2019-06-18T11:56:16+0000",
      "creator_task_id": "fd50fdd1-0482-4c9b-b847-fc9924665af6",
      "default": true,
      "external": true,
      "id": "eed97610-708d-43a5-a9a5-caebd2b7b4ee",
      "mtu": 1500,
      "name": "public",
      "port_security_enabled": true,
      "project_id": 1337,
      "region": "Luxembourg 1",
      "region_id": 7,
      "segmentation_id": 9,
      "shared": false,
      "subnets": [
        {
          "available_ips": 65432,
          "cidr": "10.0.0.0/16",
          "created_at": "2019-07-18T12:07:00+0000",
          "description": "example description",
          "enable_dhcp": true,
          "id": "80bfcb8e-1709-4bb2-99d4-3fa1332571de",
          "ip_version": 4,
          "name": "test 2",
          "network_id": "162091db-33cc-45d5-a375-964509af4813",
          "project_id": 1,
          "region": "Luxembourg 1",
          "region_id": 1,
          "tags": [
            {
              "key": "key1",
              "read_only": false,
              "value": "value1"
            }
          ],
          "total_ips": 65536,
          "updated_at": "2019-07-22T10:55:45+0000"
        },
        {
          "available_ips": 232,
          "cidr": "192.168.192.0/24",
          "created_at": "2019-07-22T15:15:05+0000",
          "description": "{\"`task_id`\": \"cc9a5445-189e-48de-a01f-5e10641a6915\"}",
          "enable_dhcp": true,
          "id": "94196a6a-c2ce-4f0d-8dc7-d9e0e722aea0",
          "ip_version": 4,
          "name": "string",
          "network_id": "162091db-33cc-45d5-a375-964509af4813",
          "project_id": 1,
          "region": "Luxembourg 1",
          "region_id": 1,
          "tags": [
            {
              "key": "key1",
              "read_only": false,
              "value": "value1"
            }
          ],
          "total_ips": 256,
          "updated_at": "2019-07-22T15:15:05+0000"
        }
      ],
      "tags": [
        {
          "key": "my-tag",
          "read_only": false,
          "value": "my-tag-value"
        }
      ],
      "task_id": null,
      "type": "vlan",
      "updated_at": "2019-06-18T11:57:00+0000"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
project_id
integer
required

Project ID

Examples:

1

​
region_id
integer
required

Region ID

Examples:

1

Query Parameters

​
limit
integer
default:1000

Optional. Limit the number of returned items

Required range: 0 < x <= 1000
Examples:

1000

​
name
string

Filter networks by name

Maximum length: 61
Examples:

"my-network"

​
network_id
string<uuid4>

Optional. Can be used to only show subnets of the specific network

Examples:

"123e4567-e89b-12d3-a456-426614174000"

​
network_type
enum<string>

Optional. Filter network by network type (vlan or vxlan)

Available options:
vlan,
vxlan
​
offset
integer
default:0

Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0
Examples:

0

​
order_by
enum<string>

Ordering networks list result by name, created_at fields of the network and directions (created_at.desc).

Available options:
created_at.asc,
created_at.desc,
name.asc,
name.desc
​
shared
boolean

Optional. Can be used to only show networks with shared state

Examples:

true

​
tag_key
string[]

Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

Tag key. The maximum size for a key is 255 bytes.

Examples:
["key1", "key2"]
​
tag_key_value
string

Optional. Filter by tag key-value pairs.

Response

200 - application/json

OK

​
count
integer
required

Number of objects

Required range: x >= 0
Examples:

1

​
results
NetworkSubnetworkSerializer · object[]
required

Objects