Callaba
Callaba home

NDI discovered devices

NDI discovered devices records the NDI sources currently visible to this Callaba instance. Configure NDI interfaces and discovery servers before using these methods; all calls require x-access-token.

Refresh and read discovery

Run sync after expected senders are online to update the saved inventory. getAll, getCount, and getById read those entries. getStat answers whether a saved device is currently being discovered. Use it when an entry appears intermittent rather than assuming a saved record proves its sender is reachable.

Record maintenance

update changes supported record fields. remove removes a stale saved entry only; it does not stop or block the NDI sender, and the source can return on a later discovery sync.

Network diagnosis

A missing device can result from interface selection, discovery-server reachability, routing, firewall rules, or sender configuration. Check NDI network configuration and run sync again before treating an absent source as a media failure.

6 endpoints
POST
/api/devices/getAll
API token required

Use Get all discovered devices for an inventory of NDI sources known to Callaba Engine.

Apply a device-type filter when needed, and refresh the list when an operator view must reflect recent discovery changes.

Request body parameters
limit
integer
Copy direct link

Optional page size for the device list.

skip
integer
Copy direct link

Optional offset for paginated listing.

sort
object
Copy direct link

Optional sort descriptor. The UI uses { created: 1 }.

filter
object
Copy direct link

Operator-facing NDI list calls usually filter by type: DEVICE_TYPE_NDI.

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

The backend returns a bare array of stored discovered-device rows.

discovered_last_time
string
Copy direct link

Timestamp of the last discovery-side refresh for this device.

Response: Get all discovered devices
[
  {
    "_id": "67f100000000000000000001",
    "id": "67f100000000000000000001",
    "name": "Studio Camera A",
    "type": "DEVICE_TYPE_NDI",
    "ndi_name": "Studio Camera A",
    "url_address": "192.168.10.41:5960",
    "created": "2026-03-24T10:00:00.000Z",
    "discovered_last_time": "2026-03-24T10:00:05.000Z",
    "success": true
  }
]
POST
/api/devices/getCount
API token required
POST
/api/devices/getById
API token required
POST
/api/devices/getStat
API token required
POST
/api/devices/update
API token required
DELETE
/api/devices/remove
API token required
Workflow examples and help
REST solution recipe

Inventory discovered NDI sources

List discovered devices, select the intended source by id, and inspect its current discovery activity before building an adapter.

  1. List NDI sourcesRead the current discovered-device inventory.POST /api/devices/getAll
  2. Check activityInspect the current discovery state before using the source downstream.POST /api/devices/getStat

Discovery reflects the current network view. Confirm the source name, address, and availability in the production segment.

Ask AI