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

# GET /v1/ports

`GET /v1/ports`

## Request

- The document declares no server URL.
- Auth: none declared

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.

## Changes

- **2021-03-12** `abba65e52027`: 1 warning, 1 info
  - removed the optional property `controllers` from the response with the `200` status
  - added the required property `ports` to the response with the `200` status
- **2020-12-18** `ca4c65fcc589`: 1 info
  - endpoint added
- **2020-06-22** `0fdcb8a77d6a`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/sodafoundation/apis/soda-infrastructure-management-api/changes/v1/ports/get.md)

---

[API](https://skmtc.dev/sodafoundation/apis/soda-infrastructure-management-api.md) - [All operations](https://skmtc.dev/sodafoundation/apis/soda-infrastructure-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sodafoundation/apis/soda-infrastructure-management-api/revisions/b2017613d719?raw)