List camera
Lists the cameras a caller may OPEN. A row somebody can never reach is a catalogue of a customer's premises and nothing else, so the admission the stream…
GET /v1/patrol/camera
| Address | https://api.hanzo.ai/v1/patrol/camera |
| Method | GET |
| Operation | get_patrol_camera |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Lists the cameras a caller may OPEN. A row somebody can never reach is a catalogue of a customer's premises and nothing else, so the admission the stream enforces is asked here too rather than left to differ from it.
The stream credential is not part of a camera row — it is a KMS path the document store never holds — so what comes back says where a camera is and never how to reach it.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
site | query | string | — | Site narrows the list to one site by document name. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | patrol.patrolCameraList | ok |
default | problem-details | refused |
200 body — 6 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | patrol.patrolCamera[] | — | Data is the matching cameras, never their credentials. |
data[].kind | body | string | — | Kind is the camera type. |
data[].label | body | string | — | Label is what the camera is called on screen. |
data[].name | body | string | — | Name is the camera's document name and the segment /v1/patrol/camera/{name}/stream addresses it by. |
data[].online | body | boolean | — | Online says whether the camera last reported healthy. |
data[].site | body | string | — | Site is the site the camera watches. |
Failure carries the platform error shape — see Errors.
Examples
hanzo patrol camera listimport { Configuration, PatrolApi } from 'hanzoai';
const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolCamera();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_camera()cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.PatrolAPI.GetPatrolCamera(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_camera(&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).getPatrolCamera();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/camera \
-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?