---
title: "GET /v1/ports"
method: GET
path: "/v1/ports"
tags: ["Ports"]
---

# GET /v1/ports

`GET /v1/ports`

List all ports.

## Query parameters

- `limit` integer
- `offset` integer
- `sort` string
- `name` string
- `id` string
- `native_port_id` string
- `storage_id` string
- `connection_status` 'connected' | 'disconnected' | 'unknown'
- `health_status` 'normal' | 'abnormal' | 'unknown'

## Response `200`

List port query was success

- object
  - `ports` PortSpec[], required
    - `id` string, required
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `name` string, required
    - `storage_id` string
    - `native_port_id` string
    - `native_parent_id` string
    - `speed` integer
    - `max_speed` integer
    - `location` string
    - `connection_status` 'connected' | 'disconnected' | 'unknown'
    - `health_status` 'normal' | 'abnormal' | 'unknown'
    - `type` 'fc' | 'iscsi' | 'ficon' | 'fcoe' | 'eth' | 'sas' | 'ib' | 'other'
    - `logical_type` 'frontend' | 'backend' | 'service' | 'management' | 'internal' | 'maintenance' | 'interconnect' | 'other'
    - `wwn` string
    - `mac_address` string
    - `ipv4` string
    - `ipv4_mask` string
    - `ipv6` string
    - `ipv6_mask` string

## Other responses

- `401` — NotAuthorized
- `403` — Forbidden
- `500` — An unexpected error occured.

---

[API](https://skmtc.net/sodafoundation/apis/soda-infrastructure-management-api.md) · [All operations](https://skmtc.net/sodafoundation/apis/soda-infrastructure-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sodafoundation/soda-infrastructure-management-api/revisions/b2017613d719/schema)