API Reference

Note

This page renders the OpenAPI 3.1 spec at /openapi.yaml. To integrate with your tooling, download the raw spec from https://novavms-manual.novalien.com/openapi.yaml.

Download

• OpenAPI 3.1 (YAML)
• OpenAPI 3.1 (JSON) — generated from the YAML via a build step (Phase 4 polish).

What’s covered

The spec covers every endpoint documented under /developer/rest/*:

• Auth endpoints (see auth-endpoints)
• User endpoints (see user-endpoints)
• Camera endpoints (see camera-endpoints)
• Event endpoints (see event-endpoints)
• Alert endpoints (see alert-endpoints)
• Gateway endpoints (see gateway-endpoints)

Authentication

See auth how-to.

Versioning

The spec is versioned in lockstep with the API. The info.version field tracks the current production API version. Major-version changes indicate breaking changes — we will publish a migration guide alongside any bump.