Hanzo
OpenapiO11y

Lists hosts with key infrastructure metrics — CPU, memory, I/O wait and disk…

Lists hosts with key infrastructure metrics — CPU, memory, I/O wait and disk usage percentages and 15-minute load — plus an active/inactive status from…

POST /v1/o11y/infra_monitoring/hosts

Addresshttps://api.hanzo.ai/v1/o11y/infra_monitoring/hosts
MethodPOST
Operationpost_o11y_infra_monitoring_hosts
AuthAuthorization: Bearer $HANZO_API_KEY

Lists hosts with key infrastructure metrics — CPU, memory, I/O wait and disk usage percentages and 15-minute load — plus an active/inactive status from whether the host reported in the last ten minutes. Rows answer as 'list' under the default host.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression and by status, orderable by any of the five metrics, paginated by offset and limit.

Request

24 fields, body application/json (required).

FieldInTypeRequiredDescription
endbodyinteger
filterbodyo11y.HostFilter
filter.Filterbodyo11y.Filter
filter.Filter.expressionbodystringexpression to filter by following the filter syntax
filter.filterByStatusbodyany
groupBybodyo11y.GroupByKey[]
groupBy[].descriptionbodystring
groupBy[].fieldContextbodyany
groupBy[].fieldDataTypebodyany
groupBy[].namebodystringyes
groupBy[].signalbodyany
groupBy[].unitbodystring
limitbodyinteger
offsetbodyinteger
orderBybodyo11y.querybuildertypesv5.OrderBy
orderBy.directionbodyanydirection to order by
orderBy.keybodyo11y.OrderByKey
orderBy.key.descriptionbodystring
orderBy.key.fieldContextbodyany
orderBy.key.fieldDataTypebodyany
orderBy.key.namebodystringyes
orderBy.key.signalbodyany
orderBy.key.unitbodystring
startbodyinteger

Response

StatusBodyMeaning
200o11y.O11yInfraHostsOutok

200 body — 22 fields.

FieldInTypeAlwaysDescription
databodyo11y.Hosts
data.endTimeBeforeRetentionbodyboolean
data.recordsbodyo11y.HostRecord[]
data.records[].activeHostCountbodyinteger
data.records[].cpubodynumber
data.records[].diskUsagebodynumber
data.records[].hostNamebodystring
data.records[].inactiveHostCountbodyinteger
data.records[].load15bodynumber
data.records[].memorybodynumber
data.records[].metabodyobject
data.records[].meta.*bodystring
data.records[].statusbodyany
data.records[].waitbodynumber
data.totalbodyinteger
data.typebodyany
data.warningbodyo11y.QueryWarnData
data.warning.messagebodystring
data.warning.urlbodystring
data.warning.warningsbodyo11y.QueryWarnDataAdditional[]
data.warning.warnings[].messagebodystring
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y infra_monitoring hosts

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page