v32

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

Networks

List networks

Returns a list of networks. Use the owned_by query parameter to control which networks are returned: project (default) returns only networks owned by the project, any returns all networks the project can use, including shared networks.

get/cloud/v1/networks/{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_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). Default is created_at.desc. Use priority.desc to sort by shared network priority (relevant when owned_by=any).

owned_by'any' | 'project'

Controls which networks are returned. 'project' (default) returns only networks owned by the project. 'any' returns all networks that the project can use, including shared networks from other projects.

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": [
        "f00624ab-41bc-4d54-a723-1673ce32d997",
        "41e0f698-4d39-483b-b77a-18eb070e4c09"
      ],
      "tags": [
        {
          "key": "my-tag",
          "read_only": false,
          "value": "my-tag-value"
        }
      ],
      "type": "vlan",
      "updated_at": "2019-06-18T11:57:00+0000"
    }
  ]
}