OpenapiFlag
List health
Health reports that the flag engine is serving.
GET /v1/flag/health
| Address | https://api.hanzo.ai/v1/flag/health |
| Method | GET |
| Operation | get_flag_health |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Health reports that the flag engine is serving. It is not gated: liveness must be probe-able without a token.
Request
GET /v1/flag/health takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | flag.healthOut | ok |
default | problem-details | refused |
200 body — 2 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
engine | body | string | — | Engine names the evaluator this deployment runs. |
ok | body | boolean | — | OK is true whenever the flag engine is serving. |
Failure carries the platform error shape — see Errors.
Examples
hanzo flag healthimport { Configuration, FlagApi } from 'hanzoai';
const api = new FlagApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFlagHealth();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FlagApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FlagApi(client).get_flag_health()cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.FlagAPI.GetFlagHealth(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, flag_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = flag_api::get_flag_health(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FlagApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new FlagApi(client).getFlagHealth();The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/flag/health \
-H "Authorization: Bearer $HANZO_API_KEY"Tool flags, op get_flag_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": "flags",
"arguments": {
"op": "get_flag_health",
"input": {}
}
}
}'How is this guide?