Skip to main content

Show Network Port Details

GET/v2.0/ports/{port_id}

Retrieve the details of a single network port by its ID.

Default policy settings allow you to view ports owned by your project (unless you have administrative privileges).

Request​

Path Parameters​

port_idstringrequired

The ID of the port to retrieve.

Query Parameters​

fieldsstring

Limits the returned attributes. Can be repeated (e.g. ?fields=id&fields=name). If omitted, all attributes allowed by policy are returned.

Example Request​

curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:9696/v2.0/ports/2d74fa0c-3e43-4fd9-a234-cbb4996cc684

Response​

Response Parameters​

If successful the API returns a single port object with the attributes below.

portobjectrequired

Port object wrapper.

idstringrequired

Port ID.

namestringrequired

Human-readable name of the port.

network_idstringrequired

ID of the attached network.

tenant_idstringrequired

Project ID (legacy field).

project_idstringrequired

Owning project ID.

mac_addressstringrequired

MAC address of the port (may be overridden for direct-physical).

admin_state_upbooleanrequired

Administrative state (true or false).

statusstringrequired

Port status: ACTIVE, DOWN, BUILD, or ERROR.

device_idstringrequired

ID of the attached device (server, router, etc.).

device_ownerstringrequired

Entity type using the port (e.g. compute:nova).

fixed_ipsarrayrequired

List of {subnet_id, ip_address} assigned to the port.

port_security_enabledbooleanrequired

Whether port security is enabled.

qos_policy_idstringrequired

QoS policy directly applied to the port (or null).

qos_network_policy_idstringrequired

QoS policy of the parent network (or null).

security_groupsarrayrequired

Security group IDs applied.

binding:vnic_typestringrequired

vNIC type: normal, macvtap, direct, baremetal, direct-physical, virtio-forwarder, smart-nic, remote-managed.

binding:profileobjectrequired

Backend-specific VIF info (empty {} if none).

binding:host_idstringrequired

Host ID where the port resides.

binding:vif_typestringrequired

Mechanism driver type or unbound / binding_failed.

binding:vif_detailsobjectrequired

Additional info (e.g. port_filter, ovs_hybrid_plug).

allowed_address_pairsarrayrequired

Allowed address pairs (ip_address, optional mac_address).

extra_dhcp_optsarrayrequired

Extra DHCP option objects.

descriptionstringrequired

Description.

resource_requestobject

Placement resources & traits requested.

tagsarrayrequired

Tag list.

created_atstringrequired

Creation timestamp (ISO 8601).

updated_atstringrequired

Last update timestamp (ISO 8601) or recent timestamp.

revision_numberintegerrequired

Revision number.

ip_allocationstringrequired

Allocation mode: immediate, deferred, or none (if present).

dns_assignmentobjectrequired

Internal DNS assignment (hostname, ip_address, fqdn).

dns_domainstringrequired

DNS domain.

dns_namestringrequired

DNS name.

hintsobjectrequired

OVS Userspace Tx packet steering hints (admin-only) if present.

numa_affinity_policystring

NUMA affinity policy: none, required, preferred, or legacy.

propagate_uplink_statusbooleanrequired

Uplink status propagation flag.

mac_learning_enabledboolean

Whether MAC learning is enabled.

port_trusted_vifbooleanrequired

Trusted VIF status (also in binding:profile).

data_plane_statusstringrequired

Underlying data plane status if reported.

Status Codes​

Success​

CodeReason
200 - OKRequest was successful.

Error​

CodeReason
401 - UnauthorizedUser must authenticate before making a request.
404 - Not FoundThe requested port could not be found.

Example Response​

Response body
{
    "port": {
        "id": "2d74fa0c-3e43-4fd9-a234-cbb4996cc684",
        "name": "private-port",
        "network_id": "f858b8d1-e66b-4a48-bc2e-3f16483b1b58",
        "tenant_id": "f33507157a634f1cac71e06a70fb558e",
        "mac_address": "fa:16:3e:7f:ae:b2",
        "admin_state_up": true,
        "status": "DOWN",
        "device_id": "",
        "device_owner": "",
        "fixed_ips": [
            {
                "subnet_id": "adffaac8-2261-43f7-9e4f-6044230f65f1",
                "ip_address": "192.168.1.12"
            }
        ],
        "allowed_address_pairs": [],
        "extra_dhcp_opts": [],
        "security_groups": [
            "e1c1aa83-7302-4493-9cf4-43c2407e8074"
        ],
        "description": "",
        "binding:vnic_type": "normal",
        "port_security_enabled": true,
        "qos_policy_id": null,
        "qos_network_policy_id": "dfc42ced-02c8-4b1f-bbe6-14cc014f259d",
        "tags": [],
        "created_at": "2025-10-08T08:05:12Z",
        "updated_at": "2025-10-08T08:05:12Z",
        "revision_number": 1,
        "project_id": "f33507157a634f1cac71e06a70fb558e"
    }
}

See Also​