nexalwarenexalwaredocs
API ReferenceRules

Delete a rule

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.
DELETE
/api/v1/devices/{deviceId}/rules/{ruleId}

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 (schedules, rules, grants, keys, device configuration) 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 endpoints are.

In: header

Path Parameters

deviceId*string
ruleId*string

Response Body

application/json

application/json

curl -X DELETE "https://example.com/api/v1/devices/dev_a1b2c3/rules/rul_x1y2z3"
{  "ok": true}

Create a rule POST

A rule condition can only reference a telemetry metric this device has already reported at least once. The action command is checked the same way an unattended schedule action is - commands marked `requiresApproval` cannot be used here.

Get the metrics and commands available for building a rule GET

Next Page