v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

Networks

List networks with subnets details

Retrieve the list of directly-attachable networks with subnet details. Returned entities may or may not be owned by the project.

Deprecated: Use GET /v1/networks/{project_id}/{region_id}?owned_by=any instead.

get/cloud/v1/availablenetworks/{project_id}/{region_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

Query parameters

externalboolean

Filter by external network status

Example:true

Filter by external network status

limitinteger

Optional. Limit the number of returned items

Example:1000

Optional. Limit the number of returned items

namestring

Filter networks by name

Example:my-network

Filter networks by name

network_idstring uuid4

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

Example:123e4567-e89b-12d3-a456-426614174000

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

network_type'vlan' | 'vxlan'

Filter by network type (vlan or vxlan)

offsetinteger

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

order_by'created_at.asc' | 'created_at.desc' | 'name.asc' | 'name.desc' | 'priority.desc'

Ordering networks list result by name, created_at or priority fields and directions (e.g. created_at.desc).

sharedboolean

Filter by shared state

Example:true

Filter by shared state

tag_keystring[]

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

[
  "key1",
  "key2"
]

tag_key_valuestring

Optional. Filter by tag key-value pairs.

Response

countinteger required

Number of objects

Example response

{
  "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,
      "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"
        }
      ],
      "type": "vlan",
      "updated_at": "2019-06-18T11:57:00+0000"
    }
  ]
}