REST API

Search…

REST API

See our Postman collection for our API documentation

Akenza provides a REST API for programmatic access to its features. If you have any questions or want to request new API features, please submit a feature in our canny board.
A set of examples, showing how to use the API:
GitHub - akenza-io/akenza-examples: A set of examples for using the `akenza` API
GitHub
The API documentation can be found here:
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 2mo ago

Copy link

On this page

API-keys

Authenticating Requests

get

Example Request