Cluster Stream

Returns detailed information about a specific stream.

Request

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

Request

bash

curl -X GET "{BASE_URL}/api/cluster/streams/{streamKey}" \
  -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}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Basic Info

Parameter	Type	Description
`data.id`	string	Unique identifier of the stream
`data.state`	string	Stream state (e.g., `"PUBLISHED"`)
`data.streamKey`	string	Stream key
`data.applicationType`	string	Application type (e.g., `"TRANSCODE"`)
`data.applicationId`	string	Unique identifier of the associated application
`data.applicationName`	string	Application name
`data.viewerCount`	integer	Number of active viewers watching this stream
`data.substreamCount`	integer	Number of sub-stream variants
`data.bitrateCount`	integer	Current bitrate in bytes/sec
`data.healthScore`	integer	Stream health score (0-100, 0 when no data available)
`data.healthGrade`	string	Stream health grade (e.g., `"Very Good"`, `"Bad"`, `"No Data"`)
`data.aliasList`	string[]	List of stream aliases

Preview List

Parameter	Type	Description
`data.previewList`	array	Array of server nodes where the stream is available
`data.previewList[].serverName`	string	Server name
`data.previewList[].nodeHostname`	string	Server hostname
`data.previewList[].nodePort`	integer	Server port
`data.previewList[].nodeSSL`	boolean	Whether the connection uses SSL
`data.previewList[].applicationName`	string	Application name on this node

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": {
    "applicationType": "TRANSCODE",
    "previewList": [
      {
        "serverName": "StormDev2",
        "nodePort": 443,
        "nodeSSL": true,
        "applicationName": "edge",
        "nodeHostname": "stormdev2.web-anatomy.com"
      },
      {
        "serverName": "StormDev2",
        "nodePort": 443,
        "nodeSSL": true,
        "applicationName": "edge",
        "nodeHostname": "stormdev2.web-anatomy.com"
      },
      {
        "serverName": "StromDev1",
        "nodePort": 443,
        "nodeSSL": true,
        "applicationName": "edge",
        "nodeHostname": "stormdev1.web-anatomy.com"
      }
    ],
    "viewerCount": 1,
    "healthScore": 88,
    "healthGrade": "Very Good",
    "streamKey": "123",
    "bitrateCount": 440694,
    "aliasList": [],
    "substreamCount": 1,
    "id": "cs_6ih59lbjml94zj9e",
    "state": "PUBLISHED",
    "applicationId": "c_xl5uslmaml5gls7l",
    "applicationName": "transcode"
  },
  "meta": {
    "executionTime": 2,
    "generatedAt": 1770283531317
  }
}

Error Responses

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

Other Errors (4xx/5xx)

json

{
  "message": "Viewer not found"
}

Support Needed?

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