---
title: "Report the port pool."
method: GET
path: "/api/ports"
tags: ["ports"]
---

# Report the port pool.

`GET /api/ports`

## Request

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

The configured ports as runs, how many are free, and every port that is not free with the reservation and flow holding it. Only ports that are reserved, assigned or blocked are listed, so the response is proportional to what is interesting rather than to pool size. Unlike the reservation routes this answers on a server with no pool configured, reporting `enabled: false`.

## Response `200`

The pool, configured or not

- PortPoolStatus: The pool, and everything in it that is not free. `entries` lists only ports that are reserved, assigned or blocked, so the response is proportional to what is interesting rather than to pool size — a pool of nine hundred idle ports answers with an empty list.
  - `enabled` boolean, required: Whether any ports are configured. Every reservation route answers 503 while this is `false`.
  - `entries` PortEntry[], required: Every port that is not free.
    - `flow_id` string, uuid, nullable: The flow declared against it, when the state is `assigned`.
    - `owner_id` string, nullable: The owner holding it, when a reservation does.
    - `port` integer, required: The port.
    - `reservation_id` string, uuid, nullable: The reservation holding it.
    - `state` 'reserved' | 'assigned' | 'blocked', required: What a port is doing.
  - `free` integer, required: How many no reservation holds and no probe has blocked.
  - `ports` PortSpan[], required: The configured ports, as runs, ascending.
    - `first` integer, required: Lowest port in the run.
    - `last` integer, required: Highest port in the run, inclusive.
  - `total` integer, required: How many ports the pool holds.

## Changes

- **2026-09-28** `fd671a19e55a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/eyevinn/apis/strom-api/changes/api/ports/get.md)

---

[API](https://skmtc.dev/eyevinn/apis/strom-api.md) - [All operations](https://skmtc.dev/eyevinn/apis/strom-api/llms.txt) - [OpenAPI document](https://skmtc.dev/eyevinn/apis/strom-api/revisions/8cd4dbc44175?raw)