Shinobi
Documentation
Home  /  API

RESTful API

Simple and Efficient

Everything that the official dashboard does is through the Shinobi API. Meaning If you decide to build your own user interface or just using certain functions of Shinobi; The API will make quick work of it.

When you authenticate with Shinobi it will offer you an Authorization Token. This token is your Session Key as well and can be used as an API Key. This key will remain active for 15 minutes after the last acivity or while your WebSocket is connected.

Create an API Key or Login to get started.

/api/managing-api-keys-ui
/api/managing-api-keys-api
/api/get-monitors
/api/get-streams
/api/embedding-streams
/api/get-videos
/api/add-edit-or-delete-a-monitor
/api/modifying-a-video-or-deleting-it
/api/monitor-triggers
/api/superuser-only
/api/administrator-only
/api/monitor-states-preset-configurations
/api/scheduling-for-monitors
/api/system-triggers
/api/direct-camera-management-via-onvif

ShinobiDocs

All content is property of their respective owners.