Cluster Sources List

Returns source list for a specific stream, including details about each source node.

Request

Property	Value
Method	`GET`
URL	`/api/cluster/streams/{streamKey}/sources`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/cluster/streams/{streamKey}/sources" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

Parameter	Type	Required	Description
`streamKey`	string	Yes	Unique identifier of the stream

Request

bash

curl -X GET "{BASE_URL}/api/cluster/streams/{streamKey}/sources" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Stream Info

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

Source

Parameter	Type	Description
`data.sourceList[].id`	string	Unique identifier of the stream source
`data.sourceList[].state`	string	Source state (e.g., `"PUBLISHED"`)
`data.sourceList[].applicationType`	string	Application type (e.g., `"TRANSCODE"`, `"ORIGIN"`)
`data.sourceList[].applicationId`	string	Unique identifier of the associated application
`data.sourceList[].applicationName`	string	Application name
`data.sourceList[].serverName`	string	Server name where the source is running
`data.sourceList[].bitrate`	integer	Current bitrate in bytes/sec
`data.sourceList[].resolution`	string	Video resolution (e.g., `"1920x1080"`)
`data.sourceList[].viewers`	integer	Number of active viewers on this source
`data.sourceList[].subStreams`	string[]	List of available sub-stream variants
`data.sourceList[].priority`	integer	Source priority
`data.sourceList[].healthScore`	integer	Source health score (0-100, 0 when no data available)
`data.sourceList[].healthGrade`	string	Source health grade (e.g., `"Very Good"`, `"Good"`, `"Bad"`, `"No Data"`)
`data.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": {
    "streamKey": "123",
    "sourceList": [
      {
        "applicationType": "TRANSCODE",
        "serverName": "StromDev1",
        "bitrate": 440696,
        "healthScore": 84,
        "healthGrade": "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": 439197,
        "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
      }
    ]
  },
  "meta": {
    "executionTime": 1,
    "generatedAt": 1770286994973
  }
}

Error Responses

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

Stream Not Found (404)

json

{
  "message": "Stream not found"
}

Support Needed?

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