Fleet Health
Reference for the fleet_health endpoints of the Surfmeter API.
Surfmeter API – Fleet Health v1
The Surfmeter API lets you manage clients, users, capabilities, measurements, and organization-wide settings programmatically.
Servers
| Description | URL |
|---|---|
| https://surfmeter-server.{host}/client_admin_api/v1 | https://surfmeter-server.{host}/client_admin_api/v1 |
Fleet Health
GET /fleet_health
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys. |
Response 200 OK
- application/json
{
"client_health_states": [
{
"client_id": 0,
"client_uuid": "string",
"client_label": "string",
"state": null,
"reasons": [
{
"metric": "string",
"percent": 10.12,
"severity": null
}
],
"metric_summary": {},
"evaluated_at": "2026-01-15T10:30:00Z",
"threshold_snapshot": {},
"thresholds_outdated": true,
"source_system_status_record_id": 0,
"network_transport": "string"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the response body
Schemas
FleetHealthIndexResponse
| Name | Type |
|---|---|
client_health_states |
Array<Properties: client_id, client_uuid, client_label, state, reasons, metric_summary, evaluated_at, threshold_snapshot, thresholds_outdated, source_system_status_record_id, network_transport> |
Security schemes
<tr>
<td>ApiKeyAuth</td>
<td>apiKey</td>
<td></td>
<td>API key used on every request. Create keys in the Surfmeter Dashboard
under Keys → Surfmeter API Keys.
</tbody>
| Name | Type | Scheme | Description |
|---|