Search

Public API

Overview

Use cases

Accessing Public API/Swagger UI

Adding a system access token

Public API secrets

Examples

Overview

The primary use case for public APIs is to import data into other applications, such as Splunk. This way, you can merge Login Enterprise data in your preferred dashboard or data collector to have all data centralized.

The Public API of Login Enterprise is built on the REST Web API standard. You can use the APIs to pull data from the Login Enterprise instance. This data can then be used for your specific goal.

Important notes:

  • 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.
  • Applies to Appliance version 6.0 and higher: V4 and V5 of the Public API have been removed.

Use cases

Bulk administration

Using the API makes managing your Login Enterprise environment at scale much easier. Instead of manually handling one-off tasks in the web interface, you can create, modify, and maintain multiple Tests or user accounts in a fraction of the time. For example, you might rely on tools like Postman to send automated requests that create or update a range of Tests in a single go.

Data retrieval and external analysis

The API provides quick, programmatic access to your Login Enterprise instance's Test results and performance metrics. This data can be fed directly into external analytics or reporting platforms, such as Microsoft Power BI—to generate custom dashboards, track long-term trends, and compare different Test sets. This approach helps ensure you’re getting the most out of your data, whether you’re looking for insights or just need a better way to visualize results.

Scheduling, starting, and stopping Tests

By tapping into the API’s capabilities, you can set up Test runs according to your own schedule, kick off Tests on demand, or pause them as needed—all without clicking through the web interface. This gives you the flexibility to integrate testing into your existing workflows and processes, making it easier to keep Tests running smoothly at all times.

Integration with third-party systems for alerts and maintenance

The API also simplifies integration with platforms like ServiceNow, making it possible to automatically create and manage ITSM tickets when critical issues arise. If a published desktop resource

Accessing Public API/Swagger UI

To access the Public API in the Login Enterprise, follow these steps:

1. In the Sidebar menu, navigate to Other > Access control.

Frame 928.png

2. In Access control, select Public API from the tab bar menu.

Frame 927 (1).png

3. In Public API, click Public API documentation (this will redirect you to the API Reference).

16.png

4. Under Download OpenAPI specification > v7.0 preview, click Documentation (ReDoc). 

Frame 929 (1).png

5. In v7.0, click API Console (Swagger) to interact with the Public API through the browser.

Frame 930 (1).png

Note: In Login Enterprise version 5 and earlier, the Public API is available under the External notifications menu.

Adding a system access token

1. In Public API, click the + on the top right.

Frame 931.png

2. In Adding a system access token, provide a description (name) and the access level type for your token.

Frame 58.png

  • Read-Only
    • Only able to retrieve collected data and configurations.
  • Schedule
    • Includes Read-Only functionality and adds enable and disable tests.
  • Configuration
    • Includes Read-Only and Schedule functionality and adds complete read and write capabilities.

3. Click Save to apply the changes. The new access token will be available instantly.

For security purposes, this is the only time you can view the Public API token. Make sure you create a backup of this key, otherwise, you will need to recreate it.

Frame 59.png

Public API secrets

An API secret is used for authentication against Login Enterprise Public APIs.

By default, there are two users (clients) with different permissions, one is for reading information from the API, and the other is used for simple control actions.

Note, however, that this way of authentication is now deprecated.

  • ReadonlyPublicAPI
    • Reads data from results and configuration.
  • ControlPublicAPI
    • Allows starting and stopping environment schedules (Tests). That is, starting and stopping a Load Test.

Frame 56.png

If your secret is compromised, you can renew it to eliminate possible security breaches. At that moment, the old secret is discarded and cannot be used for authentication.

To regenerate a new secret, click Refresh next to your key or delete the old key.

Frame 60.png

Examples