For AI agents: the docs index is at https://apidocs.lumana.ai/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Edge Sync
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
Add a custom event
put
Edit a custom event
patch
Get all custom events
get
Delete custom event
del
Search custom events
post
Count custom events
post
Insert custom events
post
Lumana API
Health
Get platform status
get
Authentication
Live View
Start camera local live view
get
Start camera live view
get
Start cameras live view
get
Start cameras local live view
get
Get link to live view
get
Start cameras live view with Auth0 guest token
get
Start cameras live view for shared wall
get
Local Data Channel
Establish local WebRTC data channel with core
post
Establish local WebRTC data channel with core (granted access)
post
Playback
Stream historical footage (Deprecated v1)
get
Stop active stream session
get
Get video timeline
get
Get active sessions
get
Stream historical footage (v2)
get
Cameras
Get all cameras
get
Get all cameras in location
get
Get camera status
get
Get camera rtsp url
get
Get camera network information
get
Get camera metadata
get
Update camera metadata
patch
Thumbnails
Get closest snapshot
get
Get closest thumbnail
get
Arm
Change alarm status
patch
Get alarm status
get
Alerts
Search alerts
post
Get alert thumbnail
get
Event
Change the event status to Enabled or Disabled
patch
Variables
Create or update a variable
post
Update a variable
put
Get all variables
get
Delete a variable
del
Get variable by name
get
Webhook
Verify HMAC signature using http-request secret
post
Network
Get ip addresses
get
Edge Sync
Search
Search persons
post
Search vehicles
post
Get tracker thumbnail
get
Get tracker identity image
get
FacePersons
Create a person
post
Update a person
put
Get a person
get
Get all people
get
Delete a person
del
FaceGroups
Create a group
post
Get all groups
get
Get group details
get
Delete a group
del
Activity Log
Get activity logs in CSV or JSON format
get
Archives
Create archive
post
Get archive
get
Get archives
get
Get archive by ID
get
Delete archive
del
PTZ
Send PTZ command
post
List presets
get
Create preset
post
Rename preset
put
Delete preset
del
Update preset position
post
Mark preset as home
post
Register native preset
post
Delete native preset
del
Get PTZ patrols
get
Update PTZ patrols
put
Set active PTZ patrol
post
Dictionary
List objects
get
List alert types
get
List event tags
get
List occupancy entrances
get
List counting zones
get
List schedules
get
Reports
Containers report
post
License plates report
post
Attendance report
post
Alerts summaries report
post
Alerts report
post
Occupancy report
post
Flex Reports
Objects flex report
post
Alerts flex report
post
Event tags flex report
post
Occupancy flex report
post
External reports
Upload an external report
post
List external reports
get
Get a download URL
get
Get an external report
get
Rename an external report
patch
Delete an external report
del
Troubleshooting
Ping a host from a Core
post
Test a Core connection to Lumana
post
Resolve a hostname from a Core
post
Trace the network path from a Core
post
Check the Lumana allow list from a Core
post
Run a speed test from a Core
post
Test every camera of a Core
post
Check the installation of a Core
post
Get live information from a Core
post
Test a camera stream from a Core
post
Get live stream metrics for cameras
get
Access Control Events
Export access control events in CSV or JSON format
get
Powered by
Copy Page
Edge Sync
Updated 10 months ago
Get ip addresses
Search
Did this page help you?
Yes
No
Updated 10 months ago
Get ip addresses
Search
Did this page help you?
Yes
No
