Getting started with the Indeni API

Indeni’s API allows you to access the functionality of the Indeni platform via a programmatic interface. Using Indeni’s API, you can automate some actions available on the user interface. This will allow you to automate repetitive tasks, integrate with third party applications, create customized output on your own software and in formats more suitable to your own needs, and more.

The Indeni API is based on HTTPS requests and JSON responses.

---

To get started, obtain your API key (also referred to as “token”) by clicking on:

Settings > API > GENERATE

Select the generated API key, then simply copy and paste to your development platform. This will allow you to send requests to the Indeni server via any programming interface which supports RESTful HTTPS requests.

There are several actions available to you through the API:

GET functions can be used to retrieve lists of devices, issues, alerts, credential data and jobs;

PATCH commands can be used to change archive status of issues, add notes to issues, edit credential sets, update device status, retry a job;

POST commands can be used to add new devices, add notes to issues, update and add new credential sets;

DELETE commands can be used to delete devices, subnet items and credentials.

---

For example, assume you want to archive all currently unarchived issues present on your device named “myDevice”.    

Step 1:  Use a GET function to return the list of unarchived issues on myDevice:

curl -X GET 
“https://<server address & path> 
device_ids={ID of myDevice}
&archived=false“
-H “accept: application/json”
-H “X-Api-Key: xxxxxxxxxxxxxxxx”

Step 2:  Use a PATCH command to archive the open issues:

{ “archived”: true,
“issue_ids”: [“xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”]  }

For each function and command, several arguments are enterable  – some arguments are optional, with defaults if arguments are left undefined. 

You can view the complete syntaxes, functions and commands executable on the Indeni API in the link below:   

https://<Indeni Server IP>/documentation/