nexalwarenexalwaredocs
API ReferenceRules

List a device's automation rules

Dashboard-only

This mirrors what a human does from the Nexalware web app - it's not meant to be automated by a third-party integration, even though a session token from Log in can technically call it. If you're building an integration that controls devices, use an API key instead: have an Owner/Admin grant it access to a device (a DeviceGrant), and use the Device Control endpoints.
GET
/api/v1/devices/{deviceId}/rules

Authorization

sessionAuth
AuthorizationBearer <token>

A session token for an existing account, obtained from POST /auth/login (see the Authentication endpoints) - not an API key. Endpoints marked with this scheme reject API key callers outright, regardless of what that key is granted. Outside the Authentication endpoints themselves, everything requiring this scheme manages dashboard resources (rules, grants, keys, device configuration, command catalogs) and mirrors what a human does in the Nexalware web app - it is not meant to be automated by a third-party integration the way the Device Control and Schedules endpoints are.

In: header

Path Parameters

deviceId*string

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/devices/dev_a1b2c3/rules"
[  {    "ruleId": "string",    "deviceId": "string",    "name": "string",    "enabled": true,    "priority": 0,    "conditions": [      {        "metric": "string",        "comparator": ">",        "value": 0      }    ],    "action": {      "command": "string",      "params": null    },    "lastMatched": true  }]

Get the metrics and commands available for building a rule GET

The telemetry metrics this device has actually reported (only these can be used in a condition) and its command catalog (only ACTION commands not marked requiresApproval can be used as the rule's action). Use this to populate a rule builder UI before calling POST .../rules.

Update a rule PATCH

Next Page