For AI agents: visit https://apidocs.lumana.ai/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

v1.0

API Reference

v1.0API Reference

Lumana API overview

Live View
Historical Footage (HLS Playback)
Live View Local (HLS)
Event Tag How To Post data

Lumana Event Tags API

Custom Events

Lumana API

Health
- Get platform statusget
Authentication
Live View
local-data-channel
- Establish local WebRTC data channel with edgepost
Playback
Cameras
Thumbnails
- Get closest snapshotget
- Get closest thumbnailget
Arm
- Change alarm statuspatch
- Get alarm statusget
Alerts
- Search alertspost
- Get alert thumbnailget
Event
- Change the event status to Enabled or Disabledpatch
Variables
Webhook
- Verify HMAC signature using http-request secretpost
Network
- Get ip addressesget
Edge Sync
Search
FacePersons
FaceGroups
Activity Log
- Get activity logs in CSV or JSON formatget
Archives
- Create archivepost
- Get archiveget
PTZ
- PTZ commandpost

Powered by

Authentication

All API requests must be authenticated using an API key. You can generate your API key in the VMS under Organization Settings → API Keys.

Updated 4 months ago

Get platform status

Did this page help you?

Updated 4 months ago

Get platform status

Did this page help you?