nexalwarenexalwaredocs
API ReferenceApi keys

Create an API key

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.
POST
/api/v1/keys

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).

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/keys" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "keyId": "string",  "name": "string",  "type": "SECRET",  "key": "string"}

Shorthand for sending the ON command POST

Previous Page

List everything a key has been granted GET

Every DeviceGrant scoping this key to a device or project, across your whole account - the reverse view of a device's own Permissions tab, for seeing (and eventually managing) a single key's whole reach in one place.