List healthz

Reports which signer this deployment mints with, and in which env.

GET /v1/licensing/healthz

Addresshttps://api.hanzo.ai/v1/licensing/healthz
MethodGET
Operationget_licensing_healthz
AuthAuthorization: Bearer $HANZO_API_KEY

Reports which signer this deployment mints with, and in which env.

It answers 200 whenever the process is up: there is nothing downstream to probe, since KMS is read only when a token is actually minted. Its value is the signer field — "signer":"local" on a production host says that deployment is signing licenses with a development key, which is a misconfiguration worth paging on rather than a healthy 200.

Request

GET /v1/licensing/healthz takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200licensing.HealthViewok
defaultproblem-detailsrefused

200 body — 4 fields.

FieldInTypeAlwaysDescription
envbodystring—Env is the deployment environment ("dev" | "staging" | "prod").
servicebodystring—Service is always "licensing".
signerbodystring—Signer names where the signing key lives: "kms" or "local".
statusbodystring—Status is "ok" whenever the process is up — this is not a dependency probe.

Failure carries the platform error shape — see Errors.

Examples

hanzo licensing healthz
import { Configuration, LicensingApi } from 'hanzoai';

const api = new LicensingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getLicensingHealthz();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import LicensingApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = LicensingApi(client).get_licensing_healthz()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.LicensingAPI.GetLicensingHealthz(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, licensing_api};

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

let result = licensing_api::get_licensing_healthz(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.LicensingApi;

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

var result = new LicensingApi(client).getLicensingHealthz();
curl https://api.hanzo.ai/v1/licensing/healthz \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool licensing, op get_licensing_healthz — 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": "licensing",
         "arguments": {
           "op": "get_licensing_healthz",
           "input": {}
         }
       }
     }'

Licensing API · All Hanzo APIs · Interactive reference

Was this page useful?