Hanzo
OpenapiO11y

Lists monitored hosts over a time range, each with its CPU, memory, I/O wait…

Lists monitored hosts over a time range, each with its CPU, memory, I/O wait and 15-minute load, whether it is actively reporting, its OS and its…

POST /v1/o11y/hosts/list

Addresshttps://api.hanzo.ai/v1/o11y/hosts/list
MethodPOST
Operationpost_o11y_hosts_list
AuthAuthorization: Bearer $HANZO_API_KEY

Lists monitored hosts over a time range, each with its CPU, memory, I/O wait and 15-minute load, whether it is actively reporting, its OS and its attributes; filterable, groupable and paginated. The answer also says whether any host metrics were received at all and which clusters and nodes sent them, so an empty page is distinguishable from a fleet that never reported.

Request

24 fields, body application/json (required).

FieldInTypeRequiredDescription
endbodyintegerepoch time in ms
filtersbodyo11y.FilterSet
filters.itemsbodyo11y.FilterItem[]
filters.items[].keybodyo11y.AttributeKey
filters.items[].key.dataTypebodystring
filters.items[].key.isColumnbodyboolean
filters.items[].key.isJSONbodyboolean
filters.items[].key.keybodystring
filters.items[].key.typebodystring
filters.items[].opbodystring
filters.items[].valuebodyobject
filters.opbodystring
groupBybodyo11y.AttributeKey[]
groupBy[].dataTypebodystring
groupBy[].isColumnbodyboolean
groupBy[].isJSONbodyboolean
groupBy[].keybodystring
groupBy[].typebodystring
limitbodyinteger
offsetbodyinteger
orderBybodyo11y.OrderBy
orderBy.columnNamebodystring
orderBy.orderbodystring
startbodyintegerepoch time in ms

Response

StatusBodyMeaning
200o11y.O11yHostListOutok

200 body — 19 fields.

FieldInTypeAlwaysDescription
databodyo11y.HostListResponse
data.clusterNamesbodystring[]
data.endTimeBeforeRetentionbodyboolean
data.isSendingK8SAgentMetricsbodyboolean
data.nodeNamesbodystring[]
data.recordsbodyo11y.HostListRecord[]
data.records[].activebodyboolean
data.records[].cpubodynumber
data.records[].hostNamebodystring
data.records[].load15bodynumber
data.records[].memorybodynumber
data.records[].metabodyobject
data.records[].meta.*bodystring
data.records[].osbodystring
data.records[].waitbodynumber
data.sentAnyHostMetricsDatabodyboolean
data.totalbodyinteger
data.typebodystring
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y hosts list

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page