Networks

Virtual network management operations

List networks

get

Lists networks to which the project has access.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Query parameters

admin_state_upbooleanOptional

Filter the list result by the administrative state of the resource.

idstringOptional

Filter the list result by the ID of the resource.

namestringOptional

Filter the list result by the human-readable name of the resource.

project_idstringOptional

Filter the list result by the ID of the project that owns the resource.

tenant_idstringOptional

Filter the list result by the ID of the project that owns the resource.

sharedbooleanOptional

Filter the network list result based on if the network is shared across all tenants.

statusstring · enumOptional

Filter the list result by status.

Possible values:

router:externalbooleanOptional

Filter the network list result based on whether the network has an external routing facility.

fieldsstringOptional

The fields that you want the server to return. If no fields are specified, all fields are returned.

sort_dirstring · enumOptional

Sort direction. A valid value is asc (ascending) or desc (descending).

Possible values:

sort_keystringOptional

Sorts by a resource attribute.

tagsstringOptional

A list of tags to filter the list result by. Resources that match all tags in this list will be returned.

tags-anystringOptional

A list of tags to filter the list result by. Resources that match any tag in this list will be returned.

not-tagsstringOptional

A list of tags to filter the list result by. Resources that match all tags in this list will be excluded.

not-tags-anystringOptional

A list of tags to filter the list result by. Resources that match any tag in this list will be excluded.

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

get

/v2.0/networks

HTTPcURLJavaScriptPython

GET /neutron/v2.0/networks HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

{
  "networks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "admin_state_up": true,
      "status": "ACTIVE",
      "shared": true,
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "subnets": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "router:external": true,
      "provider:network_type": "flat",
      "provider:physical_network": "text",
      "provider:segmentation_id": 1,
      "mtu": 1,
      "port_security_enabled": true,
      "dns_domain": "text",
      "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000",
      "availability_zone_hints": [
        "text"
      ],
      "availability_zones": [
        "text"
      ],
      "ipv4_address_scope": "123e4567-e89b-12d3-a456-426614174000",
      "ipv6_address_scope": "123e4567-e89b-12d3-a456-426614174000",
      "l2_adjacency": true,
      "vlan_transparent": true,
      "qinq": true,
      "is_default": true,
      "segments": [
        {
          "provider:network_type": "text",
          "provider:physical_network": "text",
          "provider:segmentation_id": 1
        }
      ],
      "tags": [
        "text"
      ],
      "revision_number": 1,
      "created_at": "2025-12-19T16:18:05.909Z",
      "updated_at": "2025-12-19T16:18:05.909Z"
    }
  ]
}

Create network

post

Creates a network.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Body

application/json

Responses

201

Network created successfully

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/v2.0/networks

HTTPcURLJavaScriptPython

POST /neutron/v2.0/networks HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 605

{
  "network": {
    "name": "text",
    "description": "text",
    "admin_state_up": true,
    "shared": false,
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "provider:network_type": "text",
    "provider:physical_network": "text",
    "provider:segmentation_id": 1,
    "mtu": 1,
    "port_security_enabled": true,
    "dns_domain": "text",
    "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000",
    "router:external": true,
    "vlan_transparent": true,
    "is_default": true,
    "availability_zone_hints": [
      "text"
    ],
    "segments": [
      {
        "provider:network_type": "text",
        "provider:physical_network": "text",
        "provider:segmentation_id": 1
      }
    ]
  }
}

{
  "network": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "admin_state_up": true,
    "status": "ACTIVE",
    "shared": true,
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "subnets": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "router:external": true,
    "provider:network_type": "flat",
    "provider:physical_network": "text",
    "provider:segmentation_id": 1,
    "mtu": 1,
    "port_security_enabled": true,
    "dns_domain": "text",
    "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000",
    "availability_zone_hints": [
      "text"
    ],
    "availability_zones": [
      "text"
    ],
    "ipv4_address_scope": "123e4567-e89b-12d3-a456-426614174000",
    "ipv6_address_scope": "123e4567-e89b-12d3-a456-426614174000",
    "l2_adjacency": true,
    "vlan_transparent": true,
    "qinq": true,
    "is_default": true,
    "segments": [
      {
        "provider:network_type": "text",
        "provider:physical_network": "text",
        "provider:segmentation_id": 1
      }
    ],
    "tags": [
      "text"
    ],
    "revision_number": 1,
    "created_at": "2025-12-19T16:18:05.909Z",
    "updated_at": "2025-12-19T16:18:05.909Z"
  }
}

Show network details

get

Shows details for a network.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

network_idstring · uuidRequired

The ID of the network.

Query parameters

fieldsstringOptional

The fields that you want the server to return. If no fields are specified, all fields are returned.

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/v2.0/networks/{network_id}

HTTPcURLJavaScriptPython

GET /neutron/v2.0/networks/{network_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

{
  "network": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "admin_state_up": true,
    "status": "ACTIVE",
    "shared": true,
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "subnets": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "router:external": true,
    "provider:network_type": "flat",
    "provider:physical_network": "text",
    "provider:segmentation_id": 1,
    "mtu": 1,
    "port_security_enabled": true,
    "dns_domain": "text",
    "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000",
    "availability_zone_hints": [
      "text"
    ],
    "availability_zones": [
      "text"
    ],
    "ipv4_address_scope": "123e4567-e89b-12d3-a456-426614174000",
    "ipv6_address_scope": "123e4567-e89b-12d3-a456-426614174000",
    "l2_adjacency": true,
    "vlan_transparent": true,
    "qinq": true,
    "is_default": true,
    "segments": [
      {
        "provider:network_type": "text",
        "provider:physical_network": "text",
        "provider:segmentation_id": 1
      }
    ],
    "tags": [
      "text"
    ],
    "revision_number": 1,
    "created_at": "2025-12-19T16:18:05.909Z",
    "updated_at": "2025-12-19T16:18:05.909Z"
  }
}

Update network

put

Updates a network.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

network_idstring · uuidRequired

The ID of the network.

Body

application/json

Responses

200

Network updated successfully

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

412

Precondition Failed

application/json

put

/v2.0/networks/{network_id}

HTTPcURLJavaScriptPython

PUT /neutron/v2.0/networks/{network_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "network": {
    "name": "text",
    "description": "text",
    "admin_state_up": true,
    "shared": true,
    "provider:network_type": "text",
    "provider:physical_network": "text",
    "provider:segmentation_id": 1,
    "mtu": 1,
    "port_security_enabled": true,
    "dns_domain": "text",
    "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000",
    "router:external": true,
    "segments": [
      {
        "provider:network_type": "text",
        "provider:physical_network": "text",
        "provider:segmentation_id": 1
      }
    ]
  }
}

{
  "network": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "admin_state_up": true,
    "status": "ACTIVE",
    "shared": true,
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "subnets": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "router:external": true,
    "provider:network_type": "flat",
    "provider:physical_network": "text",
    "provider:segmentation_id": 1,
    "mtu": 1,
    "port_security_enabled": true,
    "dns_domain": "text",
    "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000",
    "availability_zone_hints": [
      "text"
    ],
    "availability_zones": [
      "text"
    ],
    "ipv4_address_scope": "123e4567-e89b-12d3-a456-426614174000",
    "ipv6_address_scope": "123e4567-e89b-12d3-a456-426614174000",
    "l2_adjacency": true,
    "vlan_transparent": true,
    "qinq": true,
    "is_default": true,
    "segments": [
      {
        "provider:network_type": "text",
        "provider:physical_network": "text",
        "provider:segmentation_id": 1
      }
    ],
    "tags": [
      "text"
    ],
    "revision_number": 1,
    "created_at": "2025-12-19T16:18:05.909Z",
    "updated_at": "2025-12-19T16:18:05.909Z"
  }
}

Delete network

delete

Deletes a network and its associated resources.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

network_idstring · uuidRequired

The ID of the network.

Responses

204

Network deleted successfully

401

Unauthorized

application/json

404

Not Found

application/json

409

Conflict

application/json

412

Precondition Failed

application/json

delete

/v2.0/networks/{network_id}

HTTPcURLJavaScriptPython

DELETE /neutron/v2.0/networks/{network_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

No content