nexalwarenexalwaredocs
API ReferenceDevice control

Shorthand for sending the ON command

POST
/api/v1/devices/{deviceId}/command/on

Authorization

X-Api-Key<token>

A secret API key created on the dashboard (API Keys page). By itself it grants nothing - it must also have a DeviceGrant scoping it to the specific device(s) and command(s) it may call.

In: header

Path Parameters

deviceId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/devices/string/command/on"
{  "ok": true}

Shorthand for sending the OFF command POST

Previous Page

Create an API key POST

The raw key is returned once, at creation only, and cannot be recovered afterward. A new key can call nothing until a DeviceGrant is created for it (see the Grants endpoints). **Next step:** copy the `key` value from the response (starts with `nxw_live_sk_`), then call POST /devices/{deviceId}/grants with this key's `keyId` to actually let it do something.