Skip to main content

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

{
"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
{
"type": "object",
"required": [
"client_health_states"
],
"properties": {
"client_health_states": {
"type": "array",
"items": {
"type": "object",
"required": [
"client_id",
"client_uuid",
"state",
"reasons",
"metric_summary",
"threshold_snapshot",
"thresholds_outdated"
],
"properties": {
"client_id": {
"type": "integer"
},
"client_uuid": {
"type": "string"
},
"client_label": {
"type": "string",
"nullable": true
},
"state": {
"enum": [
"healthy",
"warning",
"critical",
"unknown"
]
},
"reasons": {
"type": "array",
"items": {
"type": "object",
"required": [
"metric",
"percent",
"severity"
],
"properties": {
"metric": {
"type": "string"
},
"percent": {
"type": "number"
},
"severity": {
"enum": [
"warning",
"critical"
]
}
}
}
},
"metric_summary": {
"type": "object",
"additionalProperties": {
"type": "object",
"required": [
"percent",
"warning_percent",
"critical_percent"
],
"properties": {
"percent": {
"type": "number",
"nullable": true
},
"warning_percent": {
"type": "number"
},
"critical_percent": {
"type": "number"
}
}
}
},
"evaluated_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2026-01-15T10:30:00Z"
},
"threshold_snapshot": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "integer"
},
{
"type": "boolean"
}
]
}
},
"thresholds_outdated": {
"type": "boolean"
},
"source_system_status_record_id": {
"type": "integer",
"nullable": true
},
"network_transport": {
"type": "string",
"nullable": true
}
}
}
}
}
}

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