Hanzo
OpenapiO11y

Lists the alert rules that reference a metric.

Lists the alert rules that reference a metric.

GET /v1/o11y/metrics/alerts

Addresshttps://api.hanzo.ai/v1/o11y/metrics/alerts
MethodGET
OperationGetMetricAlerts
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the alert rules that reference a metric.

Request

1 field.

FieldInTypeRequiredDescription
metricNamequerystringyesMetricName is the metric's name; it may contain slashes, e.g.

Response

StatusBodyMeaning
200o11y.O11yMetricAlertsOutok

200 body — 5 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yMetricAlerts
data.alertsbodyo11y.O11yMetricAlert[]Alerts are the alert rules referencing the metric.
data.alerts[].alertIdbodystringAlertID is the alert rule's id.
data.alerts[].alertNamebodystringAlertName is the alert rule's name.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y metrics alerts --metric-name <metric-name>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page