akenza.io
Search…
akenza.io
Overview
Guides
Getting Started
Connect a Device
Product manual
Organizations & Workspaces
Asset Management
Connectivity Management
Data Flows
Rules
Output Connectors & Actions
Custom Device Types
Reference
REST API
WebSocket API
Devices
HTTP
MQTT
CoAP
LoRaWAN
Scripting
Payload Templating
Grafana Data Source Plugin
Tutorials
Devices
Notifications
Enterprise solutions
IoT Starter Kit
Support Center
Changelog
FAQ
Service Desk
Powered By GitBook
REST API
See our Postman collection for our API documentation
Akenza provides a REST API for a subset of its features. If you have any questions or want to request new API features, please email [email protected].
akenza API
akenza API

API-keys

API-keys can be used to authenticate API Requests without having to provide a User JWT in the request. This is often used when writing an application based on akenza services.
API-keys are created on Organization level and have permissions, which can be specified to suit the use case for the API-key. This means that API-keys can be denied access to certain parts of the Organization and its Workspaces, or a complete feature altogether.
API-keys can be found under the API-key menu entry. They can only be created and viewed by Organization Owners and Organization Administrators. Other Members of the Organization have no access to API-keys.
API-keys with assigned premissions

Authenticating Requests

Requests can be authenticated with an API Key by providing the x-api-key header. The value of the header is the secret of the API Key.
If the request is out of the specified permission scopes (e.g. Organization Delete) the API will return permission denied error.
get
https://api.akenza.io
/v3/assets
Example Request
​
​
Product manual - Previous
Custom Device Types
Next - Reference
WebSocket API
Last modified 5mo ago
Copy link
Contents
API-keys
Authenticating Requests
get
Example Request