List health

Reports that the scanning subsystem is serving and how many secret-detection rules the engine holds.

GET /v1/security/health

Security → · All API references → · Get started →

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

Reports that the scanning subsystem is serving and how many secret-detection rules the engine holds.

It has no external dependency — the answer is ok whenever the findings store opened — so it measures this process rather than anything downstream. It reads no tenant: a prober that sends no principal is answered, not refused.

Request

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

Response

Status	Body	Meaning
`200`	security.ruleset	ok
`default`	problem-details	refused

200 body — 2 fields.

Field	In	Type	Always	Description
`rules`	body	integer (int64)	—	Rules is how many detection rules the engine holds.
`status`	body	string	—	Status is "ok" whenever the findings store opened.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo security health

.ts

.py

.go

.rs

.java

import { Configuration, SecurityApi } from 'hanzoai';

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

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = SecurityApi(client).get_security_health()

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

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

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

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

let result = security_api::get_security_health(&cfg, Default::default()).await?;

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

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

var result = new SecurityApi(client).getSecurityHealth();

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

Tool security, op get_security_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": "security",
         "arguments": {
           "op": "get_security_health",
           "input": {}
         }
       }
     }'

Security API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList findings NextList rules