Application List (Batch)

Retrieves information about specific applications by their names.

Request

Property	Value
Method	`POST`
URL	`/api/applications/batch`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X POST "{BASE_URL}/api/applications/batch" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Request Body

Parameter	Type	Required	Description
`data.names`	string[]	Yes	Array of application names

Request Body

json

{
  "data": {
    "names": ["edge", "origin"]
  }
}

Response Body

Result Arrays

Parameter	Type	Description
`data.found`	array	Array of application objects that were found
`data.notFound`	string[]	Array of application names that were not found

Application Object

Parameter	Type	Description
`data.found[].id`	string	Unique identifier of the application
`data.found[].name`	string	Application name
`data.found[].type`	MONO \| ORIGIN \| TRANSCODE \| EDGE	Application type
`data.found[].class`	string	Internal class name of the application
`data.found[].streamCount`	integer	Number of active streams
`data.found[].viewerCount`	integer	Number of connected viewers
`data.found[].connectionCount`	integer	Total number of connections
`data.found[].inBandwidth`	integer	Incoming bandwidth in bytes/sec
`data.found[].outBandwidth`	integer	Outgoing bandwidth in bytes/sec
`data.found[].inTotalBytes`	integer	Total incoming bytes
`data.found[].outTotalBytes`	integer	Total outgoing bytes
`data.found[].clusterType`	boolean	Indicates if this is a cluster application type
`data.found[].clusterConnection`	boolean	Indicates if cluster connection is active

Cluster Connection Data

Parameter	Type	Description
`data.found[].clusterConnectionData`	object	Cluster connection details (if applicable)
`data.found[].clusterConnectionData.cmIdentity`	string	Cluster manager identity
`data.found[].clusterConnectionData.connectionState`	string	Connection state
`data.found[].clusterConnectionData.startDate`	integer	Connection start time (Unix timestamp in ms)
`data.found[].clusterConnectionData.latency`	integer	Connection latency in milliseconds
`data.found[].clusterConnectionData.packetReceived`	integer	Total packets received
`data.found[].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": {
    "found": [
      {
        "id": "edge",
        "name": "edge",
        "type": "EDGE",
        "class": "EdgeApplication",
        "streamCount": 2,
        "viewerCount": 0,
        "connectionCount": 0,
        "inBandwidth": 1078684,
        "outBandwidth": 0,
        "inTotalBytes": 160105566203,
        "outTotalBytes": 2118210760,
        "clusterType": true,
        "clusterConnection": true,
        "clusterConnectionData": {
          "cmIdentity": "mother superior",
          "connectionState": "AUTHENTICATED",
          "startDate": 1764671267591,
          "latency": 0,
          "packetReceived": 34581,
          "packetSend": 53010
        }
      }
    ],
    "notFound": [
      "origin"
    ]
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1764844076976
  }
}

Error Response (4xx/5xx)

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

Error Response

json

{
  "message": "Error message"
}

Support Needed?

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