List health

Reports subsystem liveness and the wired verification provider.

GET /v1/compliance/health

Compliance → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/compliance/health`
Method	`GET`
Operation	`get_compliance_health`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reports subsystem liveness and the wired verification provider. Fail-open on purpose: it never probes the external provider, so a provider outage cannot fail liveness.

Request

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

Response

Status	Body	Meaning
`200`	compliance.healthView	ok
`default`	problem-details	refused

200 body — 2 fields.

Field	In	Type	Always	Description
`provider`	body	string	—	Provider is the wired verification provider's name ("manual" by default).
`status`	body	string	—	Status is "ok" when the subsystem is live.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo compliance health

.ts

.py

.go

.rs

.java

import { Configuration, ComplianceApi } from 'hanzoai';

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

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ComplianceApi(client).get_compliance_health()

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

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

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

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

let result = compliance_api::get_compliance_health(&cfg, Default::default()).await?;

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

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

var result = new ComplianceApi(client).getComplianceHealth();

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

Tool compliance, op get_compliance_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": "compliance",
         "arguments": {
           "op": "get_compliance_health",
           "input": {}
         }
       }
     }'

Compliance API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList audit NextList records