Skip to content
logiccloud orchestrate

Get fleet health summary

GET
/api/v1/fleet/health
curl --request GET \
  --url http://localhost:3000/api/v1/fleet/health \
  --header 'X-API-Key: <X-API-Key>'

Returns aggregated health metrics across all devices in the organization.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-organization-id
string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

Section titled “Responses”

200

Section titled “200”

Fleet health summary retrieved successfully

Media typeapplication/json
object
totalDevices
required

Total devices in organization

number
onlineDevices
required

Devices currently online

number
offlineDevices
required

Devices currently offline

number
errorDevices
required

Devices in error state

number
avgCpuPercent

Average CPU usage across fleet (%)

object
avgMemPercent

Average memory usage across fleet (%)

object
avgDiskPercent

Average disk usage across fleet (%)

object
devicesWithHighCpu
required

Devices with CPU usage above 90%

Array<object>
object
deviceId
required
string
deviceName
required
string
cpuUsagePercent
object
memoryUsagePercent
object
diskUsagePercent
object
devicesLowDisk
required

Devices with disk usage above 85%

Array<object>
object
deviceId
required
string
deviceName
required
string
cpuUsagePercent
object
memoryUsagePercent
object
diskUsagePercent
object
recentErrors
required

Recent error log entries across fleet

Array<object>
object
deviceId
required
string
deviceName
required
string
message
required
string
timestamp
required
string
Examplegenerated
{
  "totalDevices": 1,
  "onlineDevices": 1,
  "offlineDevices": 1,
  "errorDevices": 1,
  "avgCpuPercent": {},
  "avgMemPercent": {},
  "avgDiskPercent": {},
  "devicesWithHighCpu": [
    {
      "deviceId": "example",
      "deviceName": "example",
      "cpuUsagePercent": {},
      "memoryUsagePercent": {},
      "diskUsagePercent": {}
    }
  ],
  "devicesLowDisk": [
    {
      "deviceId": "example",
      "deviceName": "example",
      "cpuUsagePercent": {},
      "memoryUsagePercent": {},
      "diskUsagePercent": {}
    }
  ],
  "recentErrors": [
    {
      "deviceId": "example",
      "deviceName": "example",
      "message": "example",
      "timestamp": "example"
    }
  ]
}

403

Section titled “403”

Forbidden — caller lacks required permission