Public API

API's can be used to pull data from the Login Enterpise instance. This data can then be used for your specific goal. 

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.

Important Note: 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

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 the secret of the API. The secret is used for authentication against our public API's. If this secret is compromised you can renew the secret. At that moment the old secret is discarded and cannot be used for authentication. You can do this by clicking the refresh button.

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. 

Example Script

To give you a more physical example of how using the API calls actually works we have created a PowerShell script as an example. The logic presented in the script can also be used in other scripting / programming languages like Python. 

The script is built to retrieve a list of available / configured environments. To achieve this yourself, using this script, we need the following items:

• Login Enterprise Appliance URL (https://myvirtualappliance.loginvsi.com)
• API Secret, see above in this article where you can find it

The script has been configured to ignore certificate errors in the event that you are using a self signed certificate. 

The token you configured will be utilised in the header of each future request to encrypt the communications. 

Next, we will supply some parameters to query our environment list API, and retrieve a list of available environments.

The authentication mechanisms within the script can be utilised for any API end point of your desire.  Currently we support a read-only API out of the box.  

#ignore self-signed certificate
if (-not ([System.Management.Automation.PSTypeName]'ServerCertificateValidationCallback').Type)
{
$certCallback = @"
 using System;
 using System.Net;
 using System.Net.Security;
 using System.Security.Cryptography.X509Certificates;
 public class ServerCertificateValidationCallback
 {
 public static void Ignore()
 {
 if(ServicePointManager.ServerCertificateValidationCallback ==null)
 {
 ServicePointManager.ServerCertificateValidationCallback += 
 delegate
 (
 Object obj, 
 X509Certificate certificate, 
 X509Chain chain, 
 SslPolicyErrors errors
 )
 {
 return true;
 };
 }
 }
 }
"@
 Add-Type $certCallback
 }
[ServerCertificateValidationCallback]::Ignore()

#define appliance URL
$URL = "https://enterprise"

#define public api secret
$secret = @{
"secret" = "123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"
} | ConvertTo-Json

#request token by posting the secret in the body of the API call
$Token = Invoke-RestMethod -uri "$URL/publicApi/v1/authentication/token" -UseBasicParsing -Method Post -ContentType 'application/json' -Body $secret

###########
#make api request for list of environments
###########

#create a header with the token
$accessToken = @{"Authorization"="Bearer $($Token.accessToken)";"Content-Type"="application/json"}

#specify request parameter for list of environments
$Req = @{
"orderBy" = "name"
"direction" = "ascending"
"count" = 20
}

#request data with call to the public api environments URL
$Results = Invoke-RestMethod -Uri "$URL/publicApi/v1/environments" -Headers $accessToken -UseBasicParsing -Method Get -ContentType 'application/json' -Body $Req

#display each environment in the results
ForEach ($item in $Results.items)
{
Write-Host $item
}