Cluster Application List

Returns a paginated list of applications connected to the cluster.

Request

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

Request

bash

curl -X GET "{BASE_URL}/api/cluster/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`	"asc" \| "desc"	No	-	Sort order
`search`	string	No	-	Search by application name
`appType`	string	No	-	Filter by application type
`group`	string	No	-	Filter by group name

With query parameters

bash

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

Response Body

Code	Description
200	Success
401	Unauthorized - Invalid or missing token
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

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 Groups

Parameter	Type	Description
`data.groupList`	string[]	List of available group names

Application Object

Parameter	Type	Description
`data.list[].id`	string	Unique application ID
`data.list[].applicationName`	string	Application name
`data.list[].type`	ORIGIN \| TRANSCODE \| EDGE	Application type
`data.list[].state`	string	Connection state
`data.list[].serverName`	string	Server display name
`data.list[].hostName`	string	Server hostname
`data.list[].groupName`	string	Server group name
`data.list[].streamCount`	integer	Current number of active streams
`data.list[].streamLimit`	integer \| null	Maximum streams allowed (null = unlimited)
`data.list[].viewerCount`	integer	Current number of connected viewers
`data.list[].viewerLimit`	integer \| null	Maximum viewers allowed (null = unlimited)
`data.list[].inBandwidth`	integer	Incoming bandwidth in bytes/sec
`data.list[].outBandwidth`	integer	Outgoing bandwidth in bytes/sec
`data.list[].bandwidthLimit`	integer \| null	Bandwidth limit in bytes/sec (null = unlimited)
`data.list[].cpuUsage`	number	CPU usage percentage (0-100)
`data.list[].memoryUsage`	integer	Memory usage in bytes
`data.list[].memoryTotal`	integer	Total available memory in bytes
`data.list[].transcodingTaskCount`	integer \| null	Current active transcoding tasks (null if N/A)
`data.list[].transcodingTaskLimit`	integer \| null	Maximum transcoding tasks (null if N/A)

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": 6,
    "itemsPerPage": 10,
    "totalPages": 1,
    "currentPage": 1,
    "hasPrevious": false,
    "hasNext": false,
    "groupList": ["Premise", "AWS"],
    "list": [
      {
        "id": "c_sgvxwnwbmk3998oy",
        "applicationName": "edge",
        "type": "EDGE",
        "state": "AUTHENTICATED",
        "serverName": "StormDev2",
        "hostName": "stormdev2.web-anatomy.com",
        "groupName": "Premise",
        "streamCount": 0,
        "streamLimit": 1000,
        "viewerCount": 0,
        "viewerLimit": 1000,
        "inBandwidth": 0,
        "outBandwidth": 0,
        "bandwidthLimit": null,
        "cpuUsage": 0.09,
        "memoryUsage": 4571312364,
        "memoryTotal": 25769803776,
        "transcodingTaskCount": null,
        "transcodingTaskLimit": null
      },
      {
        "id": "c_c0zy25y2mk3998oy",
        "applicationName": "origin",
        "type": "ORIGIN",
        "state": "AUTHENTICATED",
        "serverName": "StormDev2",
        "hostName": "stormdev2.web-anatomy.com",
        "groupName": "Premise",
        "streamCount": 0,
        "streamLimit": 1000,
        "viewerCount": 0,
        "viewerLimit": null,
        "inBandwidth": 0,
        "outBandwidth": 0,
        "bandwidthLimit": null,
        "cpuUsage": 0.09,
        "memoryUsage": 4571312364,
        "memoryTotal": 25769803776,
        "transcodingTaskCount": 0,
        "transcodingTaskLimit": 5
      }
    ]
  },
  "meta": {
    "executionTime": 1,
    "generatedAt": 1767786998271
  }
}

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.