The primary use case for public API's is to import data in to other applications like Splunk for example. This way you can merge Login Enterprise data in your preferred dashboard or data collector so you can have all data centralized.
The public API of Login Enterprise is built on the REST Web API standard. API's can be used to pull data from the Login Enterpise instance. This data can then be used for your specific goal.
You can also find our Public API documentation on our website if you do not have access to an existing Login Enterprise implementation. Click here
Applies to Appliance version 4.5.x and higher: V1 and 2 of the Public API have been removed
Applies to Appliance version 4.6 and higher: V3 of the public API has been removed
Using the Public API
The API specific documentation can be found on the Login Enterprise web interface. You can find the documentation and settings in the External Notifications section:
Once External Notifications section is opened you need to click on the public API tab:
Here you can find all API secrets. An API secret is used for authentication against our public API's.
4.2.x and older
By default there are two public API's, one is for Reading information from the API the other is used for simple control actions.
- Reads data from results and config
- Allows for starting and stopping environment schedules (tests). I.e. starting and stopping a load test.
4.3.x and newer
With the release of Login Enterprise 4.3.x we have changed our authentication methods for the API to facilitate extra functionality. Instead of delivering two default API keys you are now able to create your own based on a template. To do this simply click on the green plus icon at the top right.
You are presented with a new popup window where you can give the key a description (name) and the access level type.
- Only able to retrieve collected data and configurations
- Includes Read-Only functionality and adds enable and disable tests
- Includes Read-Only and Schedule functionality and adds complete read and write capabilities.
Once you have filled in the required information you can save the setting and you are presented with the key immediately. For security purposes this is the only time you can view the key. Make sure you create a backup of this key, else you will have to re-create it.
If a secret is compromised you can renew the secret to eliminate possible security breaches. At that moment the old secret is discarded and cannot be used for authentication. You can do this by clicking the refresh button or deleting the old key.
You can also see the Public API Documentation link. Clicking on this link will open a new tab with all of the public API specific commands and information. This can also be viewed on our website.