media server logo
PricingSign inStart in the cloud for free
API docsOverview
General settings
Ports
Cluster nodes
Additional utilities
Storages
Toggle documentation navigation
Callaba home

Ports

Use Ports to inspect the network ports allocated to Callaba resources and release an allocation that is no longer in use.

What it doesInspect or release a port allocation

Choose this whenYou need to inspect or safely release a port allocation while provisioning or resolving a listener conflict.

Use another module whenConfigure the listener in its SRT, RTMP, or route module; Ports only inspects and releases allocations.

1List allocations2Identify the owner3Release when safe
POST /api/ports/getAll
3 endpoints

Before you start

All methods require a valid x-access-token. Confirm that no active media process depends on a port before releasing it.

What you can do

  • getAll lists allocated ports with filtering and pagination.
  • getCount returns the number of matching allocations.
  • releasePort releases an eligible allocation.

Example workflow

  1. List allocations and filter by the port or owning resource.
  2. Check whether the related SRT, RTMP, route, or player process is active.
  3. Stop and remove the obsolete resource if necessary.
  4. Release the port and confirm it no longer appears in the inventory.

Common use cases

  • Resolve a failed SRT listener creation caused by an occupied port.
  • Audit which media ports must be allowed through a firewall.
  • Recover stale allocations after an event environment is dismantled.

Limits and troubleshooting

Releasing a port used by a running process can interrupt media. A free application allocation also needs to be free at the operating-system and network level. Do not treat the inventory as a substitute for firewall or socket checks.

Next steps

Return to the affected SRT server, RTMP server, or route and retry its create or update operation.

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.

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
Copy code
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
JSON
Copy code
[
  {
    "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
Back toGeneral settingsNext toCluster nodes