Cluster Application List Batch
Returns information about multiple cluster applications by their IDs. Returns found and not found applications separately.
Request
| Property | Value |
|---|---|
| Method | POST |
| URL | /api/cluster/applications/batch |
| Content-Type | application/json |
| Authentication | Bearer Token |
Request
bashcurl -X POST "{BASE_URL}/api/cluster/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 IDs |
Request Body
json{
"data": {
"names": ["c_iq8mgjtxmhyw0myw", "c_sgvxwnwbmk3998oy", "c_c0zy25y2mk3998oy"]
}
}
Response Body
| Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid or missing token |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |
Result Arrays
| Parameter | Type | Description |
|---|---|---|
data.found | array | List of found applications |
data.notFound | string[] | List of IDs that were not found |
Application Object (in data.found[])
| Parameter | Type | Description |
|---|---|---|
data.found[].id | string | Unique application ID |
data.found[].applicationName | string | Application name |
data.found[].type | ORIGIN | TRANSCODE | EDGE | Application type |
data.found[].state | string | Connection state |
data.found[].serverName | string | Server display name |
data.found[].hostName | string | Server hostname |
data.found[].groupName | string | Server group name |
data.found[].streamCount | integer | Current number of active streams |
data.found[].streamLimit | integer | null | Maximum streams allowed (null = unlimited) |
data.found[].viewerCount | integer | Current number of connected viewers |
data.found[].viewerLimit | integer | null | Maximum viewers allowed (null = unlimited) |
data.found[].inBandwidth | integer | Incoming bandwidth in bytes/sec |
data.found[].outBandwidth | integer | Outgoing bandwidth in bytes/sec |
data.found[].bandwidthLimit | integer | null | Bandwidth limit in bytes/sec (null = unlimited) |
data.found[].cpuUsage | number | CPU usage percentage (0-100) |
data.found[].memoryUsage | integer | Memory usage in bytes |
data.found[].memoryTotal | integer | Total available memory in bytes |
data.found[].transcodingTaskCount | integer | null | Current active transcoding tasks (null if N/A) |
data.found[].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": {
"found": [
{
"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.06,
"memoryUsage": 4988797916,
"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.06,
"memoryUsage": 4988797916,
"memoryTotal": 25769803776,
"transcodingTaskCount": 0,
"transcodingTaskLimit": 5
}
],
"notFound": ["c_iq8mgjtxmhyw0myw"]
},
"meta": {
"executionTime": 0,
"generatedAt": 1767789482482
}
}
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.