Skip to content

Reference in English

The method, field and type names and the descriptions below are the API's own, in English. They are left verbatim: they are the exact strings you will write in your requests.

JSON-RPC API reference

Every method, notification and type of the box's JSON-RPC API, generated from nymea's introspection (JSONRPC.Introspect). To connect and authenticate, read the guide first.

Permission badges

Every method carries the permission the account needs to call it.

Badge Scope Description
AUTH PermissionScopeNone Any authenticated account (token required whenever the transport requires authentication; only JSONRPC.Hello, Authenticate and RequestPushButtonAuth work without one)
CONTROL PermissionScopeControlThings / ExecuteRules Control of things and rules
CONFIGURE PermissionScopeConfigureThings / ConfigureRules Configuration of integrations and rules
ADMIN PermissionScopeAdmin System administration