Callaba
Callaba home

Ports

Use Ports to inspect allocations and release an eligible allocation. All methods require x-access-token.

Inspect before release

getAll lists allocations; getCount returns the matching count. Use releasePort only after confirming that its owning media process is stopped or obsolete, then confirm the allocation no longer appears in the inventory.

Releasing a port used by a running process can interrupt media. A free application allocation must still be available at operating-system and network levels.

3 endpoints
POST
/api/ports/getAll
API token required

Use this method when the team needs a current inventory of listening ports on the instance. It is most valuable before launching a new module or when troubleshooting a port collision that blocks the launch.

The response is operationally useful because it ties the port and transport to the module and entity that currently owns it.

Request body parameters
limit
integer
Copy direct link

Optional page size for the port inventory query.

skip
integer
Copy direct link

Optional offset for paginated listing.

sort
object
Copy direct link

Optional sort descriptor. The dashboard store defaults to { created: 1 }.

Get all ports
curl --request POST \
  --url http://localhost/api/ports/getAll \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sort": {
    "created": 1
  },
  "limit": 20,
  "skip": 0
}'
Response
array of port objects
array
Copy direct link

The backend returns a list of currently visible listeners with the port, transport, owning entity, and owning module.

Response: Get all ports
[
  {
    "id": "681200000000000000000001",
    "port": 1935,
    "transport": "UDP",
    "entity_name": "Main SRT ingest",
    "module_name": "MODULE_SRT_SERVERS",
    "success": true
  }
]
POST
/api/ports/getCount
API token required
POST
/api/ports/releasePort
API token required
Workflow examples and help
REST solution recipe

Audit allocated ports before releasing one

List the port inventory, confirm that no active module depends on the target, and release only the reviewed allocation.

  1. List allocationsFind the owning module and current allocation before cleanup.POST /api/ports/getAll
  2. Release the reviewed portRelease only after dependent media processes have stopped.POST /api/ports/releasePort

Releasing an in-use port can break ingest or delivery. Stop and detach the owning resource first.

Ask AI