List event

Lists the feed, newest first.

GET /v1/patrol/event

Addresshttps://api.hanzo.ai/v1/patrol/event
MethodGET
Operationget_patrol_event
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the feed, newest first. It is the same rows the live stream carries, read back for a screen that has just opened — so the window is the newest rows, or a screen that reloads reads a feed that stopped on the day the tenant was installed.

Request

2 fields.

FieldInTypeRequiredDescription
levelquerystring—Level narrows the list to red, amber, green or cyan.
limitqueryinteger—Limit caps how many rows are returned.

Response

StatusBodyMeaning
200patrol.patrolEventListok
defaultproblem-detailsrefused

200 body — 9 fields.

FieldInTypeAlwaysDescription
databodypatrol.patrolEvent[]—Data is the matching rows, newest first.
data[].atbodystring—At is when it was raised.
data[].detailbodystring—Detail is the longer account, or empty.
data[].levelbodystring—Level is red, amber, green or cyan.
data[].namebodystring—Name is the event's document name.
data[].sitebodystring—Site is the site the event is about, or empty.
data[].sourcebodystring—Source is what raised it.
data[].titlebodystring—Title is the one line the feed shows.
data[].unitbodystring—Unit is the unit the event is about, or empty.

Failure carries the platform error shape — see Errors.

Examples

hanzo patrol event get
import { Configuration, PatrolApi } from 'hanzoai';

const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolEvent();
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_event()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.PatrolAPI.GetPatrolEvent(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_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).getPatrolEvent();
curl https://api.hanzo.ai/v1/patrol/event \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool patrol, op get_patrol_event — 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_event",
           "input": {}
         }
       }
     }'

Patrol API · All Hanzo APIs · Interactive reference

Was this page useful?