Introduction

The API is designed to enable you to interact with your installtion from other systems, monitoring systems, apps or websites using any programming language that can make a web request and both send and receive json data. This documentation will provide you the methods, accepted parameters and responses from the API.

---

Token authentication

Authentication against the API is done by tokens which are assigned to a user account. You can view and create tokens using the API access link within the System > API menu.

To send the token to the API you need to do this by using the X-Auth-Token within the header. As example if your API token was 91c60e737e342c205be5bba8e2954d27 then you would send the following X-Auth-Token: 91c60e737e342c205be5bba8e2954d27. As an example using curl within PHP you would do something like this:

curl_setopt($ch, CURLOPT_HTTPHEADER, array('X-Auth-Token: 91c60e737e342c205be5bba8e2954d27'));

---

API Responses

The following responses are standard across each request type except for where an image would be returned directly, the response will be output in json format:

status

• ok = The request was successful
• error = The request failed

message

This will contain the reason for the success or failure of the request.

---

API request types

The following request types are currently used:

• GET - This is used for the retrieval of information or images.
• POST - This is used for adding new items such as devices.
• PUT - This is used to update existing items.
• DELETE - This is used to remove items.

---

Available requests