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 provides an API for a subset of its features. If you have any questions or want to request new API features, please email [email protected]  See the navigation sidebar for the list of available endpoints.  # Authorization  Request authentication is done using API Keys. The API Key must be specified in the header ```x-api-key```.  For authenticating client applications (i.e. authenticating users and access the akenza APIs on their behalf), akenza provides an OAuth2 endpoint to access the akenza API. Please contact [email protected] to get started.  # Rate limit  Rate Limiting is setup as follows (per second):  ``` replenish-rate: 10 burst-capacity: 25 ```  Information about how many requests can still be made in the next second can be found in the ```X-RateLimit-Remaining``` header of the response.
docs.api.akenza.io
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-key with assigned permissions
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 a permission denied error.
get
Example Request
https://api.akenza.io/v3/assets
This request will fetch all Assets in a workspace using an API Key for authentication.
Request
Response
Request
Headers
x-api-key
required
string
The API Key Secret
Query Parameters
workspaceId
required
string
The Workspace Id
Response
200: OK
Returns a paginated list of Assets.
{
   "content":[
      {
         "id":"02d2327fedce2128",
         "name":"some device",
         "description":null,
         "type":"DEVICE",
         ...
      }
   ],
   "pageable":{
      ...
   },
   "totalPages":1,
   "totalElements":1,
   "last":true,
   "number":0,
   "sort":{
      ...
   },
   "size":25,
   "numberOfElements":1,
   "first":true,
   "empty":false
}
403: Forbidden
Returns an error object with the status and reason if e.g. the API Key permissions don't allow access to the Asset List. 
{
    "timestamp": "2021-02-19T15:06:56.928+00:00",
    "path": "/v3/assets",
    "status": 403,
    "error": "Forbidden",
    "message": "Permission denied",
    "requestId": "64fa58b0-18361",
    "errorId": "33a00d16-6a22-4687-99ca-90bb448e5eb2",
    "traceId": "8a7c4ea8ae80a5e4"
}
​
 
​
Product manual - Previous
Custom Device Types
Next - Reference
Devices
Last updated 4 months ago
REST API

API-keys

Authenticating Requests

getExample Request

get
Example Request
