Create event

POST /v1/patrol/event

Patrol → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/patrol/event`
Method	`POST`
Operation	`post_patrol_event`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Writes one feed row by hand and pushes it to every screen watching. It is how a controller puts something on the record that no automatic write would have produced.

Request

6 fields, body application/json (required).

Field	In	Type	Required	Description
`detail`	body	string	—	Detail is the longer account.
`level`	body	string	—	Level is red, amber, green or cyan.
`site`	body	string	—	Site is the site it is about, by document name.
`source`	body	string	—	Source is what raised it.
`title`	body	string	—	Title is the one line the feed shows.
`unit`	body	string	—	Unit is the unit it is about, by call sign.

Response

Status	Body	Meaning
`201`	patrol.patrolEventOut	created
`default`	problem-details	refused

201 body — 9 fields.

Field	In	Type	Always	Description
`data`	body	patrol.patrolEvent	—
`data.at`	body	string	—	At is when it was raised.
`data.detail`	body	string	—	Detail is the longer account, or empty.
`data.level`	body	string	—	Level is red, amber, green or cyan.
`data.name`	body	string	—	Name is the event's document name.
`data.site`	body	string	—	Site is the site the event is about, or empty.
`data.source`	body	string	—	Source is what raised it.
`data.title`	body	string	—	Title is the one line the feed shows.
`data.unit`	body	string	—	Unit is the unit the event is about, or empty.

Failure carries the platform error shape — see Errors.

Examples

hanzo patrol event create

import { Configuration, PatrolApi } from 'hanzoai';

const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postPatrolEvent({ detail: "<detail>", level: "<level>" });

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).post_patrol_event(detail="<detail>", level="<level>")

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

resp, _, err := client.PatrolAPI.PostPatrolEvent(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::post_patrol_event(&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).postPatrolEvent();

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 -X POST https://api.hanzo.ai/v1/patrol/event \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "detail": "<detail>",
       "level": "<level>"
     }'

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.

Patrol API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page