OpenAPI 3.1 · generated from the server · API v0.1.5
Operator API
Everything the web UI does goes through /api/v1/*, so everything the UI does can be scripted: users and roles, cameras and per-camera access, recordings, events, installing and licensing apps. Send Authorization: Bearer with a token from POST /api/v1/auth/login.
Why "operator". The operator is whoever runs an install — the administrator who provisions it, the integration that reads from it, the automation that acts on it. This API acts with an operator's authority: a login, a role, and the same per-camera permissions the web UI enforces. Nothing here can do more than the person whose token it carries.
Who uses it. Administrators scripting provisioning across sites, a SIEM or VMS pulling events and evidence, a ticketing or notification system watching the alert inbox, a dashboard, or a home-automation flow. If you are building something that lives inside OpenNVR instead, you want an app — see the other doors.
Two other doors are not this page
Apps talk to the platform through the App SDK's client with their own credential, scoped to the cameras they were given — they never hold a user's login.
Models answer the adapter contract; the platform calls them. Neither uses the routes below.
Three doors, three credentials: a user's token here, an app key for apps, the internal key for the platform's own services.
A snapshot of the current release. Your own install serves the live document at /docs, /redoc and /openapi.json. Raw: openapi.json