Get systems status summary

GET /systems/totals

Bearer auth

Get systems heartbeat status summary for dashboard (requires Admin or Support role)

Query parameters

timeout integer

Timeout in minutes for alive/dead determination

Minimum value is 1, maximum value is 60. Default value is 15.

Responses

200 application/json

Systems status summary retrieved successfully
Hide response attributes Show response attributes object
- code integer
- message string
- data object
  
  Hide data attributes Show data attributes object
  
  total_systems integer
  
  Total number of systems
  
  alive_systems integer
  
  Number of systems that communicated within the last timeout minutes
  
  dead_systems integer
  
  Number of systems that communicated but not within timeout minutes
  
  zombie_systems integer
  
  Number of systems that were created but never communicated
  
  timeout_minutes integer
  
  Timeout used for alive/dead determination
401 application/json

Unauthorized - invalid or missing token
Hide response attributes Show response attributes object
- code integer
- message string
- data object | null
403 application/json

Forbidden - insufficient permissions
Hide response attributes Show response attributes object
- code integer
- message string
- data object | null

GET /systems/totals

curl \
 --request GET 'https://api.your-domain.com/api/systems/totals' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "code": 200,
  "message": "system status retrieved",
  "data": {
    "total_systems": 1250,
    "alive_systems": 1100,
    "dead_systems": 100,
    "zombie_systems": 50,
    "timeout_minutes": 15
  }
}

Response examples (401)

{
  "code": 401,
  "message": "invalid token",
  "data": {}
}

Response examples (403)

{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}