Shinobi
Home  /  API  /  Alarms

Alarms

http://xxx.xxx.xxx.xxx/[API KEY]/alarms/[GROUP KEY]
http://xxx.xxx.xxx.xxx/[API KEY]/alarms/[GROUP KEY]/[MONITOR ID]
http://xxx.xxx.xxx.xxx/[API KEY]/alarm/[GROUP KEY]/[MONITOR ID]?time=YYYY

This is a POST request endpoint. The data provided in the post will decide which record is edited and what data is edited. Here is a sample POST body.

{
   "mid": "monitorId",
   "time": "2025-06-17T10:24:17.000Z",
   "name": "A Chosen Name for Event",
   "notes": "People were loitering but nothing happened",
   "status": "0", // 0:Attention, 1:Acknowledged, 2:In Progress, 3:Resolved, 4:Cleared, 5:Dismissed, 6:Verified, 7:Escalated, 8:False Alarm
}
http://xxx.xxx.xxx.xxx/[API KEY]/alarm/[GROUP KEY]/[MONITOR ID]
http://xxx.xxx.xxx.xxx/[API KEY]/alarms/[GROUP KEY]/[MONITOR ID]?start=YYYY-MM-DDTHH:mm:ss
http://xxx.xxx.xxx.xxx/[API KEY]/alarms/[GROUP KEY]/[MONITOR ID]?end=YYYY-MM-DDTHH:mm:ss
http://xxx.xxx.xxx.xxx/[API KEY]/alarms/[GROUP KEY]/[MONITOR ID]?start=YYYY-MM-DDTHH:mm:ss&end=YYYY-MM-DDTHH:mm:ss
http://xxx.xxx.xxx.xxx/[API KEY]/alarms/[GROUP KEY]/[MONITOR ID]?start=YYYY-MM-DDTHH:mm:ss&startOperator=>=
http://xxx.xxx.xxx.xxx/[API KEY]/alarms/[GROUP KEY]/[MONITOR ID]?end=YYYY-MM-DDTHH:mm:ss&endOperator=<=

Normally the end parameter correlates directly to the end time of the video. This way you are searching only with start times.

http://xxx.xxx.xxx.xxx/[API KEY]/alarms/[GROUP KEY]/[MONITOR ID]?start=YYYY-MM-DDTHH:mm:ss&end=YYYY-MM-DDTHH:mm:ss&endIsStartTo

ShinobiDocs

All content is property of their respective owners.