Skip to main content

System API

Endpoints for checking server health and platform status.

Health check

GET /api/v1/health

Returns basic server liveness information. This endpoint does not require authentication.

Response

{
"status": "healthy",
"version": "1.0.0",
"timestamp": "2025-07-01T12:00:00Z"
}

System status

GET /api/v1/status

Returns platform status including active device counts, current round information, and model catalog size. Requires authentication.

Response

{
"status": "operational",
"active_devices": 42,
"total_devices": 78,
"current_round_number": 17,
"current_round_status": "active",
"total_models": 18,
"timestamp": "2025-07-01T12:00:00Z"
}
FieldTypeDescription
statusstringoperational, degraded, or maintenance
active_devicesintegerDevices with a heartbeat in the last 5 minutes
total_devicesintegerTotal registered devices
current_round_numberinteger | nullMost recent round number
current_round_statusstring | nullpending, active, aggregating, completed, or failed
total_modelsintegerTotal models in the catalog