Creating & Managing API Keys
Create, scope, and revoke API keys for the external REST API
ADMIN API keys are created and managed by Tenant Admins.
Creating a Key
Open API Keys from the tenant settings / integrations area.
Click Create key.
Enter a Name - a human-readable label (e.g. "Compliance Pipeline").
Choose Scopes - what the key is allowed to read:
| Scope | Grants read access to |
|---|---|
telemetry:read | Latest readings and historical data |
devices:read | Device list and metadata |
alarms:read | Alarm rules and instances |
If no scope is selected, the key defaults to telemetry:read.
Choose Application access:
- All applications (default), or
- Specific applications - the key can only read data from those apps
(Optional) Set an Expiry date - the key stops working after that time.
Click Create.
The full secret is shown only once, at creation time. Copy it immediately and store it somewhere safe (a secrets manager). You cannot view it again - if you lose it, rotate the key.
The Keys Table
The keys table shows, for each key:
| Column | Description |
|---|---|
| Name | The label you gave the key |
| Scopes | Which data the key can read |
| Application scope | All apps, or a specific set |
| Creator | Who created the key |
| Last used | When the key last made a request |
| Expiry | When the key stops working (if set) |
| Errors (24h) | Recent error count - spot a misbehaving integration at a glance |
Revoking a Key
Click the delete / revoke action on a key row. Revocation is immediate and permanent - any integration using that key will start receiving 401 errors.