Scopes

Every permission a key can carry. Scopes never imply one another.

A key carries exactly the scopes you grant it. Scopes do not imply one another: devices:read does not confer devices:control, so a dashboard that only displays state cannot switch anything even if its key leaks.

automations:readList automation rules.

automations:writeCreate, update, enable, disable and delete automation rules.

devices:controlSend commands to devices — switch relays, set levels, run actions.

devices:readList devices and read their current state.

devices:writeRename devices, assign rooms, and set favourites.

events:readRead the event and activity feed.

plates:readRead ANPR number-plate reads, the vehicle register and site occupancy.

plates:writeAdd, change and remove entries on the plate allow / deny / watch list.

rooms:readList rooms.

scenes:readList scenes and their actions.

scenes:runActivate a scene.

telemetry:readRead historical telemetry and energy series.

Where this list comes from

Every scope here is one the API actually requires on at least one endpoint, read out of the OpenAPI description rather than maintained by hand. If the server starts requiring a new one, it appears here without anybody remembering to add it.