Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Subnets

Network subnet management operations

List subnets

get

Lists subnets to which the project has access.

Authorizations
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
get/v2.0/subnets
GET /neutron/v2.0/subnets HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

{
  "subnets": [
    {
      "id": "26106f45-a517-4e43-95f4-7b4c56c0a8cf",
      "name": "subnet1",
      "network_id": "6c05f4a1-b900-4cdb-bff6-4017de02c837",
      "tenant_id": "0376e204a05443d3bfdf864c5be771ee",
      "project_id": "0376e204a05443d3bfdf864c5be771ee",
      "ip_version": 4,
      "cidr": "192.168.8.0/22",
      "gateway_ip": "192.168.8.1",
      "enable_dhcp": true,
      "ipv6_address_mode": null,
      "ipv6_ra_mode": null,
      "subnetpool_id": null,
      "allocation_pools": [
        {
          "start": "192.168.8.2",
          "end": "192.168.11.254"
        }
      ],
      "dns_nameservers": [],
      "host_routes": [],
      "service_types": [],
      "dns_publish_fixed_ip": false,
      "router:external": false,
      "description": "",
      "tags": [],
      "created_at": "2026-08-27T04:01:51Z",
      "updated_at": "2026-08-27T04:01:51Z",
      "revision_number": 0
    }
  ]
}

Create subnet

post

Creates a subnet.

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Body
Responses
201

Subnet created successfully

application/json
post/v2.0/subnets
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": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Show subnet details

get

Shows details for a subnet.

Authorizations
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
get/v2.0/subnets/{subnet_id}
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": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Update subnet

put

Updates a subnet.

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
subnet_idstring · uuidRequired

The ID of the subnet.

Body
Responses
200

Subnet updated successfully

application/json
put/v2.0/subnets/{subnet_id}
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": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Delete subnet

delete

Deletes a subnet.

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
subnet_idstring · uuidRequired

The ID of the subnet.

Responses
204

Subnet deleted successfully

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

No content
PreviousPorts
NextModels

Last updated

Was this helpful?