---
title: "List ports"
method: GET
path: "/v2.0/ports"
tags: ["Ports"]
---

# List ports

`GET /v2.0/ports`

Lists ports to which the project has access.

## Query parameters

- `admin_state_up` boolean
- `id` string
- `name` string
- `network_id` string
- `project_id` string
- `tenant_id` string
- `device_id` string
- `device_owner` string
- `status` 'ACTIVE' | 'BUILD' | 'DOWN' | 'ERROR'
- `fields` string
- `sort_dir` 'asc' | 'desc'
- `sort_key` string
- `tags` string
- `tags-any` string
- `not-tags` string
- `not-tags-any` string

## Response `200`

Successful operation

- PortsResponse
  - `ports` Port[]
    - `id` string, uuid
    - `name` string
    - `description` string
    - `network_id` string, uuid
    - `admin_state_up` boolean
    - `status` 'ACTIVE' | 'BUILD' | 'DOWN' | 'ERROR'
    - `mac_address` string
    - `fixed_ips` FixedIP[]
      - `subnet_id` string, uuid
      - `ip_address` string, ipv4
    - `project_id` string, uuid
    - `tenant_id` string, uuid
    - `device_id` string
    - `device_owner` string
    - `security_groups` string[]
    - `allowed_address_pairs` AllowedAddressPair[]
      - `ip_address` string
      - `mac_address` string
    - `extra_dhcp_opts` ExtraDhcpOpt[]
      - `opt_name` string
      - `opt_value` string
      - `ip_version` 4 | 6
    - `port_security_enabled` boolean
    - `dns_name` string
    - `dns_assignment` DnsAssignment[]
      - `hostname` string
      - `ip_address` string
      - `fqdn` string
    - `dns_domain` string
    - `data_plane_status` string
    - `qos_policy_id` string, uuid
    - `qos_network_policy_id` string, uuid
    - `binding:vnic_type` string
    - `binding:profile` object
    - `binding:host_id` string
    - `binding:vif_type` string
    - `binding:vif_details` object
    - `resource_request` object, nullable
    - `tags` string[]
    - `revision_number` integer
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `401` — Missing or invalid JWT token.

---

[API](https://skmtc.net/platform9/apis/cluster-blueprint-api.md) · [All operations](https://skmtc.net/platform9/apis/cluster-blueprint-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/platform9/cluster-blueprint-api/revisions/708ad90fe444/schema)