Application List

Returns a paginated list of applications on the server.

Request

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

Request

bash

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

Query Parameters

Parameter	Type	Required	Default	Description
`page`	integer	No	1	Page number
`rowsPerPage`	integer	No	10	Number of items per page
`orderBy`	string	No	-	Field name to sort by
`order`	string	"asc" \| "desc"	-	Sort order
`search`	string	No	-	Filter by application name
`appType`	string	"MONO" \| "ORIGIN" \| "TRANSCODE" \| "EDGE"	-	Filter by application type

With query parameters

bash

curl -X GET "{BASE_URL}/api/applications?page=value&rowsPerPage=value&orderBy=value" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Pagination

Parameter	Type	Description
`data.totalItems`	integer	Total number of applications
`data.itemsPerPage`	integer	Number of items per page
`data.totalPages`	integer	Total number of pages
`data.currentPage`	integer	Current page number
`data.hasPrevious`	boolean	Indicates if a previous page exists
`data.hasNext`	boolean	Indicates if a next page exists

Application Object

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

Cluster Connection Data

Parameter	Type	Description
`data.list[].clusterConnectionData`	object	Cluster connection details (if applicable)
`data.list[].clusterConnectionData.cmIdentity`	string	Cluster manager identity
`data.list[].clusterConnectionData.connectionState`	string	Connection state
`data.list[].clusterConnectionData.startDate`	integer	Connection start time (Unix timestamp in ms)
`data.list[].clusterConnectionData.latency`	integer	Connection latency in milliseconds
`data.list[].clusterConnectionData.packetReceived`	integer	Total packets received
`data.list[].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": {
    "totalItems": 2,
    "itemsPerPage": 10,
    "totalPages": 1,
    "currentPage": 1,
    "hasPrevious": false,
    "hasNext": false,
    "list": [
      {
        "id": "edge",
        "name": "edge",
        "type": "EDGE",
        "class": "EdgeApplication",
        "streamCount": 2,
        "viewerCount": 0,
        "connectionCount": 0,
        "inBandwidth": 723147,
        "outBandwidth": 0,
        "inTotalBytes": 159585154096,
        "outTotalBytes": 2118210760,
        "clusterType": true,
        "clusterConnection": true,
        "clusterConnectionData": {
          "cmIdentity": "mother superior",
          "connectionState": "AUTHENTICATED",
          "startDate": 1764671267591,
          "latency": 0,
          "packetReceived": 34439,
          "packetSend": 52796
        }
      },
    ]
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1764843363860
  }
}

Error Response (4xx/5xx)

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

json

{
  "message": "Error message"
}

Support Needed?

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