List key
Lists the key register. Neither the officer nor the client reaches it: patrol.key is its own DocType and its permissions name neither, so there is no key…
GET /v1/patrol/key
| Address | https://api.hanzo.ai/v1/patrol/key |
| Method | GET |
| Operation | get_patrol_key |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Lists the key register. Neither the officer nor the client reaches it: patrol.key is its own DocType and its permissions name neither, so there is no key row for either to read.
Request
GET /v1/patrol/key takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | patrol.patrolKeyList | ok |
default | problem-details | refused |
200 body — 6 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | patrol.patrolKey[] | — | Data is every key set held. |
data[].holder | body | string | — | Holder is who has it now. |
data[].moved | body | string | — | Moved is when it last changed hands. |
data[].name | body | string | — | Name is the key set's reference, which is its document name. |
data[].site | body | string | — | Site is the site the keys open. |
data[].where | body | string | — | Where is where the set is kept. |
Failure carries the platform error shape — see Errors.
Examples
hanzo patrol key listimport { Configuration, PatrolApi } from 'hanzoai';
const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolKey();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatrolApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).get_patrol_key()cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.PatrolAPI.GetPatrolKey(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, patrol_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = patrol_api::get_patrol_key(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatrolApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new PatrolApi(client).getPatrolKey();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/patrol/key \
-H "Authorization: Bearer $HANZO_API_KEY"MCP declares no tool for patrol — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?