Cluster Source

Returns detailed information about a specific stream source.

Request

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

Request

bash

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

Path Parameters

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

Request With Parameters

bash

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

Response Body

Source Info

Parameter	Type	Description
`data.id`	string	Unique identifier of the stream source
`data.state`	string	Source state (e.g., `"PUBLISHED"`)
`data.streamKey`	string	Stream key
`data.applicationType`	string	Application type (e.g., `"TRANSCODE"`, `"ORIGIN"`)
`data.applicationId`	string	Unique identifier of the associated application
`data.applicationName`	string	Application name
`data.resolution`	string	Video resolution (e.g., `"1920x1080"`)
`data.bitrateCount`	integer	Current bitrate in bytes/sec
`data.substreamCount`	integer	Number of sub-stream variants
`data.healthScore`	integer	Source health score (0-100, 0 when no data available)
`data.healthGrade`	string	Source health grade (e.g., `"Very Good"`, `"Good"`, `"Bad"`, `"No Data"`)
`data.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",
    "bitrateCount": 440698,
    "applicationType": "TRANSCODE",
    "substreamCount": 1,
    "id": "cs_6ih59lbjml94zj9e",
    "state": "PUBLISHED",
    "healthScore": 88,
    "healthGrade": "Very Good",
    "applicationId": "c_xl5uslmaml5gls7l",
    "resolution": "1920x1080",
    "applicationName": "transcode",
    "createDate": 1770276611482
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1770287210383
  }
}

Error Response (4xx/5xx)

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

Source Not Found (404)

json

{
  "message": "Source not found"
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

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