---
title: "List Ports"
method: GET
path: "/api/v1/extension/ports"
tags: ["Extension"]
---

# List Ports

`GET /api/v1/extension/ports`

List Ports.

## Query parameters

- `limit` integer, nullable — Requests a page size of items. Returns a number of items up to a limit value.
- `marker` string, nullable — The ID of the last-seen item.
- `sort_dirs` 'desc' | 'asc'
- `sort_keys` PortSortKey[], nullable — Indicates in which attributes to sort.
- `all_projects` boolean, nullable — List ports for all projects.
- `project_id` string, nullable — Filter the list of ports by the given project ID.
- `name` string, nullable — Filter the list of ports by the given port name.
- `status` 'ACTIVE' | 'DOWN' | 'BUILD' | 'ERROR' | 'N/A'
- `network_name` string, nullable — Filter the list of ports by the given network name.
- `network_id` string, nullable — Filter the list of ports by the given network ID.
- `device_id` string, nullable — The ID of the device that uses this port. For example, a server instance or a logical router.
- `device_owner` PortDeviceOwner[], nullable — The entity type that uses this port.
- `uuid` string[], nullable — Filter the list of ports by the given port UUID.

## Headers

- `X-Openstack-Request-Id` string

## Response `200`

OK

- PortsResponse
  - `ports` PortsResponseBase[], required — Ports list
    - `id` string, required — Port ID
    - `origin_data` object, required — The origin_data is the same like the response of https://docs.openstack.org/api-ref/network/v2/index.html?expanded=list-ports-detail#list-ports
    - `server_name` string, nullable — Server name
    - `network_name` string, nullable — Network name
    - `ipv4` unknown[], nullable — IPv4 addresses
      - unknown
    - `ipv6` unknown[], nullable — IPv6 addresses
      - unknown
    - `name` string, nullable, required — Will be removed, please use origin_data[name]
    - `mac_address` string, nullable, required — Will be removed, please use origin_data[mac_address]
    - `project_id` string, nullable, required — Will be removed, please use origin_data[project_id]
    - `device_owner` string, nullable, required — Will be removed, please use origin_data[device_owner]
    - `device_id` string, nullable, required — Will be removed, please use origin_data[device_id]
    - `status` string, nullable, required — Will be removed, please use origin_data[status]
    - `created_at` string, nullable, required — Will be removed, please use origin_data[created_at]
    - `network_id` string, nullable, required — Will be removed, please use origin_data[network_id]
    - `binding_vnic_type` string, nullable, required — Will be removed, please use origin_data[binding:vnic_type]
    - `description` string, nullable, required — Will be removed, please use origin_data[description]
    - `port_security_enabled` boolean, nullable, required — Will be removed, please use origin_data[port_security_enabled]
    - `qos_policy_id` string, nullable, required — Will be removed, please use origin_data[qos_policy_id]
    - `fixed_ips` unknown[], nullable, required — Will be removed, please use origin_data[fixed_ips]
      - unknown

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `422` — Validation Error
- `500` — Internal Server Error

---

[API](https://skmtc.dev/openstack/apis/skyline-api.md) · [All operations](https://skmtc.dev/openstack/apis/skyline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openstack/skyline-api/revisions/4b7c0ce8c025/schema)