Skip to main content

API Key

All endpoints require authentication via the X-API-Key header, except GET /health.

Roles

Device Scoping

Non-admin users are restricted to specific devices using the allowed_hardware_ids field on their user record. This scoping applies to:
  • REST API — all /devices/:id/* routes, /lock-events, /trips
  • WebSocketsubscribe and command messages
Users with allowed_hardware_ids set to null have no device access. You must explicitly set it to an array for the user to access any devices.