Ports

Network port management operations

List ports

get

Lists ports 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.

network_idstringOptional

Filter the list result by the network ID.

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.

device_idstringOptional

Filter ports by device ID.

device_ownerstringOptional

Filter ports by device owner.

statusstring · enumOptional

Filter the list result by status.

Possible values:

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

HTTPcURLJavaScriptPython

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

{
  "ports": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "network_id": "123e4567-e89b-12d3-a456-426614174000",
      "admin_state_up": true,
      "status": "ACTIVE",
      "mac_address": "text",
      "fixed_ips": [
        {
          "subnet_id": "123e4567-e89b-12d3-a456-426614174000",
          "ip_address": "0.0.0.0"
        }
      ],
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "device_id": "text",
      "device_owner": "text",
      "security_groups": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "allowed_address_pairs": [
        {
          "ip_address": "text",
          "mac_address": "text"
        }
      ],
      "extra_dhcp_opts": [
        {
          "opt_name": "text",
          "opt_value": "text",
          "ip_version": 4
        }
      ],
      "port_security_enabled": true,
      "dns_name": "text",
      "dns_assignment": [
        {
          "hostname": "text",
          "ip_address": "text",
          "fqdn": "text"
        }
      ],
      "dns_domain": "text",
      "data_plane_status": null,
      "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000",
      "tags": [
        "text"
      ],
      "revision_number": 1,
      "created_at": "2025-12-19T16:18:05.909Z",
      "updated_at": "2025-12-19T16:18:05.909Z"
    }
  ]
}

Create port

post

Creates a port.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Body

application/json

Responses

201

Port created successfully

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/v2.0/ports

HTTPcURLJavaScriptPython

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

{
  "port": {
    "name": "text",
    "description": "text",
    "network_id": "123e4567-e89b-12d3-a456-426614174000",
    "admin_state_up": true,
    "mac_address": "text",
    "fixed_ips": [
      {
        "subnet_id": "123e4567-e89b-12d3-a456-426614174000",
        "ip_address": "0.0.0.0"
      }
    ],
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "device_id": "text",
    "device_owner": "text",
    "security_groups": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "allowed_address_pairs": [
      {
        "ip_address": "text",
        "mac_address": "text"
      }
    ],
    "extra_dhcp_opts": [
      {
        "opt_name": "text",
        "opt_value": "text",
        "ip_version": 4
      }
    ],
    "port_security_enabled": true,
    "dns_name": "text",
    "dns_domain": "text",
    "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "port": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "network_id": "123e4567-e89b-12d3-a456-426614174000",
    "admin_state_up": true,
    "status": "ACTIVE",
    "mac_address": "text",
    "fixed_ips": [
      {
        "subnet_id": "123e4567-e89b-12d3-a456-426614174000",
        "ip_address": "0.0.0.0"
      }
    ],
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "device_id": "text",
    "device_owner": "text",
    "security_groups": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "allowed_address_pairs": [
      {
        "ip_address": "text",
        "mac_address": "text"
      }
    ],
    "extra_dhcp_opts": [
      {
        "opt_name": "text",
        "opt_value": "text",
        "ip_version": 4
      }
    ],
    "port_security_enabled": true,
    "dns_name": "text",
    "dns_assignment": [
      {
        "hostname": "text",
        "ip_address": "text",
        "fqdn": "text"
      }
    ],
    "dns_domain": "text",
    "data_plane_status": null,
    "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      "text"
    ],
    "revision_number": 1,
    "created_at": "2025-12-19T16:18:05.909Z",
    "updated_at": "2025-12-19T16:18:05.909Z"
  }
}

Show port details

get

Shows details for a port.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

port_idstring · uuidRequired

The ID of the port.

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/ports/{port_id}

HTTPcURLJavaScriptPython

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

{
  "port": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "network_id": "123e4567-e89b-12d3-a456-426614174000",
    "admin_state_up": true,
    "status": "ACTIVE",
    "mac_address": "text",
    "fixed_ips": [
      {
        "subnet_id": "123e4567-e89b-12d3-a456-426614174000",
        "ip_address": "0.0.0.0"
      }
    ],
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "device_id": "text",
    "device_owner": "text",
    "security_groups": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "allowed_address_pairs": [
      {
        "ip_address": "text",
        "mac_address": "text"
      }
    ],
    "extra_dhcp_opts": [
      {
        "opt_name": "text",
        "opt_value": "text",
        "ip_version": 4
      }
    ],
    "port_security_enabled": true,
    "dns_name": "text",
    "dns_assignment": [
      {
        "hostname": "text",
        "ip_address": "text",
        "fqdn": "text"
      }
    ],
    "dns_domain": "text",
    "data_plane_status": null,
    "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      "text"
    ],
    "revision_number": 1,
    "created_at": "2025-12-19T16:18:05.909Z",
    "updated_at": "2025-12-19T16:18:05.909Z"
  }
}

Update port

put

Updates a port.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

port_idstring · uuidRequired

The ID of the port.

Body

application/json

Responses

200

Port 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/ports/{port_id}

HTTPcURLJavaScriptPython

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

{
  "port": {
    "name": "text",
    "description": "text",
    "admin_state_up": true,
    "fixed_ips": [
      {
        "subnet_id": "123e4567-e89b-12d3-a456-426614174000",
        "ip_address": "0.0.0.0"
      }
    ],
    "device_id": "text",
    "device_owner": "text",
    "security_groups": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "allowed_address_pairs": [
      {
        "ip_address": "text",
        "mac_address": "text"
      }
    ],
    "extra_dhcp_opts": [
      {
        "opt_name": "text",
        "opt_value": "text",
        "ip_version": 4
      }
    ],
    "port_security_enabled": true,
    "dns_name": "text",
    "dns_domain": "text",
    "data_plane_status": null,
    "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "port": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "network_id": "123e4567-e89b-12d3-a456-426614174000",
    "admin_state_up": true,
    "status": "ACTIVE",
    "mac_address": "text",
    "fixed_ips": [
      {
        "subnet_id": "123e4567-e89b-12d3-a456-426614174000",
        "ip_address": "0.0.0.0"
      }
    ],
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "device_id": "text",
    "device_owner": "text",
    "security_groups": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "allowed_address_pairs": [
      {
        "ip_address": "text",
        "mac_address": "text"
      }
    ],
    "extra_dhcp_opts": [
      {
        "opt_name": "text",
        "opt_value": "text",
        "ip_version": 4
      }
    ],
    "port_security_enabled": true,
    "dns_name": "text",
    "dns_assignment": [
      {
        "hostname": "text",
        "ip_address": "text",
        "fqdn": "text"
      }
    ],
    "dns_domain": "text",
    "data_plane_status": null,
    "qos_policy_id": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      "text"
    ],
    "revision_number": 1,
    "created_at": "2025-12-19T16:18:05.909Z",
    "updated_at": "2025-12-19T16:18:05.909Z"
  }
}

Delete port

delete

Deletes a port.

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

port_idstring · uuidRequired

The ID of the port.

Responses

204

Port deleted successfully

401

Unauthorized

application/json

404

Not Found

application/json

412

Precondition Failed

application/json

delete

/v2.0/ports/{port_id}

HTTPcURLJavaScriptPython

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

No content