Cluster Application

Returns detailed information about a specific application in the cluster.

Request

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

Request

bash

curl -X GET "{BASE_URL}/api/cluster/applications/{appId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

Parameter	Type	Required	Description
`appId`	string	Yes	Application ID

Request

bash

curl -X GET "{BASE_URL}/api/cluster/applications/{appId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Code	Description
200	Success
401	Unauthorized - Invalid or missing token
404	Not Found - Application does not exist
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

Application Info

Parameter	Type	Description
`data.id`	string	Unique application ID
`data.applicationName`	string	Application name
`data.type`	ORIGIN \| TRANSCODE \| EDGE	Application type
`data.state`	string	Connection state
`data.serverName`	string	Server display name
`data.hostName`	string	Server hostname
`data.groupName`	string	Server group name

Peer Connection

Parameter	Type	Description
`data.peerHost`	string	Peer node hostname
`data.peerPort`	integer	Peer node port
`data.peerSSL`	boolean	SSL enabled for peer connection

Stream Statistics

Parameter	Type	Description
`data.streamCount`	integer	Current number of active streams
`data.streamLimit`	integer \| null	Maximum streams allowed (null = unlimited)
`data.viewerCount`	integer	Current number of connected viewers
`data.viewerLimit`	integer \| null	Maximum viewers allowed (null = unlimited)

Bandwidth Statistics

Parameter	Type	Description
`data.inBandwidth`	integer	Incoming bandwidth in bytes/sec
`data.outBandwidth`	integer	Outgoing bandwidth in bytes/sec
`data.bandwidthLimit`	integer \| null	Bandwidth limit in bytes/sec (null = unlimited)

Resource Usage

Parameter	Type	Description
`data.cpuUsage`	number	CPU usage percentage (0-100)
`data.memoryUsage`	integer	Memory usage in bytes
`data.memoryTotal`	integer	Total available memory in bytes

Transcoding Statistics

Parameter	Type	Description
`data.transcodingTaskCount`	integer	Current active transcoding tasks
`data.transcodingTaskLimit`	integer	Maximum transcoding tasks

Thread Statistics

Parameter	Type	Description
`data.totalWorkerThreads`	integer	Total worker threads available
`data.activeWorkerThreads`	integer	Currently active worker threads
`data.totalReaderThreads`	integer	Total reader threads available
`data.activeReaderThreads`	integer	Currently active reader threads
`data.totalWriterThreads`	integer	Total writer threads available
`data.activeWriterThreads`	integer	Currently active writer threads
`data.totalTransportThreads`	integer	Total transport threads available
`data.activeTransportThreads`	integer	Currently active transport threads

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": {
    "id": "c_xbwzd82mmk399ca3",
    "applicationName": "origin",
    "type": "ORIGIN",
    "state": "AUTHENTICATED",
    "serverName": "StromDev1",
    "hostName": "stormdev1.web-anatomy.com",
    "groupName": "AWS",
    "peerHost": "stormdev1.web-anatomy.com",
    "peerPort": 443,
    "peerSSL": true,
    "streamCount": 0,
    "streamLimit": 10,
    "viewerCount": 0,
    "viewerLimit": null,
    "inBandwidth": 0,
    "outBandwidth": 0,
    "bandwidthLimit": null,
    "cpuUsage": 0.2,
    "memoryUsage": 3078153863,
    "memoryTotal": 25769803776,
    "transcodingTaskCount": 0,
    "transcodingTaskLimit": 10,
    "totalWorkerThreads": 32,
    "activeWorkerThreads": 0,
    "totalReaderThreads": 16,
    "activeReaderThreads": 0,
    "totalWriterThreads": 48,
    "activeWriterThreads": 0,
    "totalTransportThreads": 32,
    "activeTransportThreads": 0
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1767786274854
  }
}

Error Responses

Application Not Found (404)

Other Errors (4xx/5xx)

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

json

{
  "message": "Application not found"
}

json

{
  "message": "Error message"
}

Support Needed?

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