Hanzo
OpenapiMq

Reports whether the message plane behind this surface answers.

Reports whether the message plane behind this surface answers.

GET /v1/mq/health

Addresshttps://api.hanzo.ai/v1/mq/health
MethodGET
Operationget_mq_health
AuthAuthorization: Bearer $HANZO_API_KEY

Reports whether the message plane behind this surface answers.

Request

GET /v1/mq/health takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200Healthok

200 body — 3 fields.

FieldInTypeAlwaysDescription
statusbodystringStatus is ok when the message plane answers, degraded otherwise.
uptimebodystringUptime is how long this surface has been mounted.
versionbodystringVersion is the connected broker's server version; empty while degraded.

Failure carries the platform error shape — see Errors.

Examples

hanzo mq health

MQ API · All Hanzo APIs · Interactive reference

How is this guide?

On this page