List health

Reports whether the message plane behind this surface answers.

GET /v1/mq/health

MQ → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/mq/health`
Method	`GET`
Operation	`get_mq_health`
Auth	`Authorization: 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

Status	Body	Meaning
`200`	mq.Health	ok
`default`	problem-details	refused

200 body — 3 fields.

Field	In	Type	Always	Description
`status`	body	string	—	Status is ok when the message plane answers, degraded otherwise.
`uptime`	body	string	—	Uptime is how long this surface has been mounted.
`version`	body	string	—	Version is the connected broker's server version; empty while degraded.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo mq health

.ts

.py

.go

.rs

.java

import { Configuration, MqApi } from 'hanzoai';

const api = new MqApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMqHealth();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MqApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MqApi(client).get_mq_health()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.MqAPI.GetMqHealth(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, mq_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = mq_api::get_mq_health(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MqApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new MqApi(client).getMqHealth();

curl https://api.hanzo.ai/v1/mq/health \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool mq, op get_mq_health — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "mq",
         "arguments": {
           "op": "get_mq_health",
           "input": {}
         }
       }
     }'

MQ API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousDelete consumer NextList info