nexalwarenexalwaredocs
API ReferenceDevices

Get a device

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}

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

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/devices/string"
{  "deviceId": "string",  "name": "string",  "boardType": "string",  "appType": "string",  "deviceStatus": "PENDING",  "enabled": true,  "deviceTypeId": "string",  "relayState": true,  "isOnline": true,  "lastSeen": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z"}

Generate MQTT credentials for a device POST

Firmware-facing credentials for connecting to the MQTT broker - not the same thing as an API key. The password is shown once and is not recoverable afterward; use "Reveal credentials" only re-shows what was already generated.

Get firmware config block GET

Next Page