Cluster Stream List (Batch)

Returns information about specific streams by their stream keys.

Request

Property	Value
Method	`POST`
URL	`/api/cluster/streams/batch`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X POST "{BASE_URL}/api/cluster/streams/batch" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Request Body

Parameter	Type	Required	Description
`names`	string[]	Yes	Array of stream keys

Request Body

json

{
  "ids": [
    "123",
    "456"
  ]
}

Query Parameters

Parameter	Type	Required	Default	Description
`page`	integer	No	1	Page number
`rowsPerPage`	integer	No	10	Number of items per page
`orderBy`	string	No	-	Field name to sort by (e.g., `"startTime"`)
`order`	string	asc \| desc	-	Sort order
`search`	string	No	-	Filter by stream key
`streamState`	string	No	-	Filter by stream state

With query parameters

bash

curl -X POST "{BASE_URL}/api/cluster/streams/batch?page=1&rowsPerPage=10" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ids": ["123", "456"]}'

Response Body

Result Arrays

Parameter	Type	Description
`data.found`	array	Array of stream objects that were found
`data.notFound`	string[]	Array of stream keys that were not found

Stream

Parameter	Type	Description
`data.found[].streamKey`	string	Stream key
`data.found[].sourceList`	array	Array of source objects

Source

Parameter	Type	Description
`data.found[].sourceList[].id`	string	Unique identifier of the stream source
`data.found[].sourceList[].state`	string	Source state (e.g., `"PUBLISHED"`)
`data.found[].sourceList[].applicationType`	string	Application type (e.g., `"TRANSCODE"`, `"ORIGIN"`)
`data.found[].sourceList[].applicationId`	string	Unique identifier of the associated application
`data.found[].sourceList[].applicationName`	string	Application name
`data.found[].sourceList[].serverName`	string	Server name where the source is running
`data.found[].sourceList[].bitrate`	integer	Current bitrate in bytes/sec
`data.found[].sourceList[].resolution`	string	Video resolution (e.g., `"1920x1080"`)
`data.found[].sourceList[].viewers`	integer	Number of active viewers on this source
`data.found[].sourceList[].subStreams`	string[]	List of available sub-stream variants
`data.found[].sourceList[].priority`	integer	Source priority
`data.found[].sourceList[].healthScore`	integer	Source health score (0-100, 0 when no data available)
`data.found[].sourceList[].healthGrade`	string	Source health grade (e.g., `"Very Good"`, `"Good"`, `"Bad"`, `"No Data"`)
`data.found[].sourceList[].createDate`	integer	Source creation time (Unix timestamp in ms)

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "found": [
      {
        "streamKey": "123",
        "sourceList": [
          {
            "applicationType": "TRANSCODE",
            "serverName": "StromDev1",
            "bitrate": 440694,
            "healthScore": 88,
            "healthGrade": "Very Good",
            "priority": 0,
            "resolution": "1920x1080",
            "viewers": 0,
            "subStreams": [
              "native",
              "360p"
            ],
            "id": "cs_6ih59lbjml94zj9e",
            "state": "PUBLISHED",
            "applicationId": "c_xl5uslmaml5gls7l",
            "applicationName": "transcode",
            "createDate": 1770276611482
          },
          {
            "applicationType": "ORIGIN",
            "serverName": "StormDev2",
            "bitrate": 439199,
            "healthScore": 88,
            "healthGrade": "Very Good",
            "priority": 0,
            "resolution": "1920x1080",
            "viewers": 0,
            "subStreams": [
              "native"
            ],
            "id": "cs_3fh51fw3ml94z2eb",
            "state": "PUBLISHED",
            "applicationId": "c_emyu51uhml5glmgy",
            "applicationName": "origin",
            "createDate": 1770276589308
          }
        ]
      }
    ],
    "notFound": [
      "456"
    ]
  },
  "meta": {
    "executionTime": 1,
    "generatedAt": 1770285785128
  }
}

Parameter	Type	Description
`message`	string	Human-readable error message

Error Response (4xx/5xx)

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.