Subnets

Network subnet management operations

List subnets

get

Lists subnets to which the project has access.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Query parameters

network_idstringOptional

Filter the list result by the network ID.

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.

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/subnets

HTTPcURLJavaScriptPython

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

{
  "subnets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "network_id": "123e4567-e89b-12d3-a456-426614174000",
      "ip_version": 4,
      "cidr": "text",
      "gateway_ip": "text",
      "dhcp_enabled": true,
      "dns_nameservers": [
        "text"
      ],
      "allocation_pools": [
        {
          "start": "text",
          "end": "text"
        }
      ],
      "host_routes": [
        {
          "destination": "text",
          "nexthop": "text"
        }
      ],
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "ipv6_address_mode": "slaac",
      "ipv6_ra_mode": "slaac",
      "subnetpool_id": "123e4567-e89b-12d3-a456-426614174000",
      "tags": [
        "text"
      ],
      "revision_number": 1,
      "created_at": "2025-12-19T16:19:41.440Z",
      "updated_at": "2025-12-19T16:19:41.440Z"
    }
  ]
}

Create subnet

post

Creates a subnet.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Body

application/json

Responses

201

Subnet created successfully

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/v2.0/subnets

HTTPcURLJavaScriptPython

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

{
  "subnet": {
    "name": "text",
    "description": "text",
    "network_id": "123e4567-e89b-12d3-a456-426614174000",
    "ip_version": 4,
    "cidr": "text",
    "gateway_ip": "text",
    "dhcp_enabled": true,
    "dns_nameservers": [
      "text"
    ],
    "allocation_pools": [
      {
        "start": "text",
        "end": "text"
      }
    ],
    "host_routes": [
      {
        "destination": "text",
        "nexthop": "text"
      }
    ],
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "ipv6_address_mode": "slaac",
    "ipv6_ra_mode": "slaac",
    "subnetpool_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "subnet": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "network_id": "123e4567-e89b-12d3-a456-426614174000",
    "ip_version": 4,
    "cidr": "text",
    "gateway_ip": "text",
    "dhcp_enabled": true,
    "dns_nameservers": [
      "text"
    ],
    "allocation_pools": [
      {
        "start": "text",
        "end": "text"
      }
    ],
    "host_routes": [
      {
        "destination": "text",
        "nexthop": "text"
      }
    ],
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "ipv6_address_mode": "slaac",
    "ipv6_ra_mode": "slaac",
    "subnetpool_id": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      "text"
    ],
    "revision_number": 1,
    "created_at": "2025-12-19T16:19:41.440Z",
    "updated_at": "2025-12-19T16:19:41.440Z"
  }
}

Show subnet details

get

Shows details for a subnet.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

subnet_idstring · uuidRequired

The ID of the subnet.

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/subnets/{subnet_id}

HTTPcURLJavaScriptPython

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

{
  "subnet": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "network_id": "123e4567-e89b-12d3-a456-426614174000",
    "ip_version": 4,
    "cidr": "text",
    "gateway_ip": "text",
    "dhcp_enabled": true,
    "dns_nameservers": [
      "text"
    ],
    "allocation_pools": [
      {
        "start": "text",
        "end": "text"
      }
    ],
    "host_routes": [
      {
        "destination": "text",
        "nexthop": "text"
      }
    ],
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "ipv6_address_mode": "slaac",
    "ipv6_ra_mode": "slaac",
    "subnetpool_id": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      "text"
    ],
    "revision_number": 1,
    "created_at": "2025-12-19T16:19:41.440Z",
    "updated_at": "2025-12-19T16:19:41.440Z"
  }
}

Update subnet

put

Updates a subnet.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

subnet_idstring · uuidRequired

The ID of the subnet.

Body

application/json

Responses

200

Subnet 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/subnets/{subnet_id}

HTTPcURLJavaScriptPython

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

{
  "subnet": {
    "name": "text",
    "description": "text",
    "gateway_ip": "text",
    "dhcp_enabled": true,
    "dns_nameservers": [
      "text"
    ],
    "allocation_pools": [
      {
        "start": "text",
        "end": "text"
      }
    ],
    "host_routes": [
      {
        "destination": "text",
        "nexthop": "text"
      }
    ]
  }
}

{
  "subnet": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "network_id": "123e4567-e89b-12d3-a456-426614174000",
    "ip_version": 4,
    "cidr": "text",
    "gateway_ip": "text",
    "dhcp_enabled": true,
    "dns_nameservers": [
      "text"
    ],
    "allocation_pools": [
      {
        "start": "text",
        "end": "text"
      }
    ],
    "host_routes": [
      {
        "destination": "text",
        "nexthop": "text"
      }
    ],
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "ipv6_address_mode": "slaac",
    "ipv6_ra_mode": "slaac",
    "subnetpool_id": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      "text"
    ],
    "revision_number": 1,
    "created_at": "2025-12-19T16:19:41.440Z",
    "updated_at": "2025-12-19T16:19:41.440Z"
  }
}

Delete subnet

delete

Deletes a subnet.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

subnet_idstring · uuidRequired

The ID of the subnet.

Responses

204

Subnet deleted successfully

401

Unauthorized

application/json

404

Not Found

application/json

409

Conflict

application/json

412

Precondition Failed

application/json

delete

/v2.0/subnets/{subnet_id}

HTTPcURLJavaScriptPython

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

No content