Get key

Returns one key set from the register.

GET /v1/patrol/key/{name}

Patrol → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/patrol/key/{name}`
Method	`GET`
Operation	`get_patrol_key_by_name`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns one key set from the register.

Request

1 field.

Field	In	Type	Required	Description
`name`	path	string	yes	Name is the key set's reference, from the path.

Response

Status	Body	Meaning
`200`	patrol.patrolKeyOut	ok
`default`	problem-details	refused

200 body — 6 fields.

Field	In	Type	Always	Description
`data`	body	patrol.patrolKey	—
`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

CLI

SDK

HTTP

MCP

hanzo patrol key get <name>

.ts

.py

.go

.rs

.java

import { Configuration, PatrolApi } from 'hanzoai';

const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolKeyByName({ name: 'name' });

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_by_name(name='name')

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

resp, _, err := client.PatrolAPI.GetPatrolKeyByName(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_by_name(&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).getPatrolKeyByName();

curl https://api.hanzo.ai/v1/patrol/key/<name> \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool patrol, op get_patrol_key_by_name — 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": "patrol",
         "arguments": {
           "op": "get_patrol_key_by_name",
           "input": {
             "name": "<name>"
           }
         }
       }
     }'

Patrol API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList incident NextList key