Application

Returns detailed information about a specific application.

Request

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

Request

bash

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

Path Parameters

Parameter	Type	Required	Description
`appName`	string	Yes	Application name

Request

bash

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

Response Body

Application Info

Parameter	Type	Description
`data.id`	string	Unique identifier of the application
`data.name`	string	Application name
`data.type`	MONO \| ORIGIN \| TRANSCODE \| EDGE	Application type
`data.class`	string	Internal class name of the application
`data.startDate`	integer	Application start time (Unix timestamp in ms)
`data.streamCount`	integer	Number of currently active streams
`data.createdStreams`	integer	Total number of streams created since start
`data.viewerCount`	integer	Number of connected viewers
`data.connectionCount`	integer	Total number of connections
`data.inBandwidth`	integer	Incoming bandwidth in bytes/sec
`data.outBandwidth`	integer	Outgoing bandwidth in bytes/sec
`data.inTotalBytes`	integer	Total incoming bytes
`data.outTotalBytes`	integer	Total outgoing bytes
`data.clusterType`	boolean	Indicates if this is a cluster application type
`data.clusterConnection`	boolean	Indicates if cluster connection is active

Cluster Connection Data

Parameter	Type	Description
`data.clusterConnectionData`	object	Cluster connection details (if applicable)
`data.clusterConnectionData.cmIdentity`	string	Cluster manager identity
`data.clusterConnectionData.connectionState`	string	Connection state
`data.clusterConnectionData.startDate`	integer	Connection start time (Unix timestamp in ms)
`data.clusterConnectionData.latency`	integer	Connection latency in milliseconds
`data.clusterConnectionData.packetReceived`	integer	Total packets received
`data.clusterConnectionData.packetSend`	integer	Total packets sent

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": "edge",
    "name": "edge",
    "type": "EDGE",
    "class": "EdgeApplication",
    "startDate": 1764671262587,
    "streamCount": 2,
    "createdStreams": 8,
    "viewerCount": 0,
    "connectionCount": 0,
    "inBandwidth": 669299,
    "outBandwidth": 0,
    "inTotalBytes": 160449978090,
    "outTotalBytes": 0,
    "clusterType": true,
    "clusterConnection": true,
    "clusterConnectionData": {
      "cmIdentity": "mother superior",
      "connectionState": "AUTHENTICATED",
      "startDate": 1764671267591,
      "latency": 0,
      "packetReceived": 34688,
      "packetSend": 53170
    }
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1764844611982
  }
}

Error Response (4xx/5xx)

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

Application Not Found (404)

json

{
  "message": "Application not found"
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

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