REST API

From Login VSI Documentation
Jump to: navigation, search

APIs provide clean data in programmatically accessible formats. There is no need to convert data from one file format to another, no need to remove poor or polluted entries and no need to upload the data into your local platform.

Our well-defined REST API is simple to use and the design makes it easy to integrate with other analytical solutions, such as Splunk, etc. If you have multiple applications or hosts that need access to the data, then you don’t have to authorize a new database connection for each one with our API.

Important: If you want to utilize our API to grab data that you can then integrate into the requisite system, please contact us and we will send you the Splunk App. To access the API via the Web, simply add the API command to the end of the Login PI URL, e.g. http://localhost:8080/connectionsapi, etc.

Disclaimer: Our API has numerous commands that are not documented here. Please feel free to play around with the different functionality but be aware that the commands not mentioned below are subject to change and are not supported by us.

Note 1: If you want to see the list of all the API commands, then open Internet Information Services (IIS) and navigate to the Login PI sub-site. Each sub application (except for api. launcherIdp and targetIdp) can be explored by right clicking the application and selecting Manage application->browse.... The browser will then open a page (Swagger) where you can see the complete list of API commands.

Note 2: When utilizing REST API commands, we recommend that you do not use large time periods when querying either raw or statistical data (no longer than one day for raw data and no longer than one week for statistics).

API Commands

Alertsapi: AlertRetrieval

This command is used to retrieve alerts for different profiles but can also provide statistical information on alert counts.

To access the command operations, click List Operations to choose between alerts and alerts count. Then click the blue GET button to expand the required operation. Alternatively, click Expand Operations to expand them both automatically.

Apialertretrieval.png

Once expanded, you will be presented with an Example Value. Underneath this example, you must select the required Response Content Type from the dropdown list. Then enter the path/query parameters as required in the following fields:

  • profileId (required): enter the path as an integer
  • minutes (optional): enter the desired amount of time in minutes

When you are ready, click the Try it out! button. The API will then return the appropriate response.

Apialertretrieval2.png Apialertretrieval3.png

Sessionmetricsapi: RawSessionMetricsData

This command is used to retrieve the raw data for different profiles, such as CPU usage, latency, bandwidth.

To access the command operations, click List Operations, then click the blue GET button to expand the operation. Alternatively, click Expand Operations to expand automatically.

Pirawsessionmetricsdata.png

Once expanded, you will be presented with an Example Value. Underneath this example, you must select the required Response Content Type from the dropdown list. Then enter the path/query parameters as required in the following fields:

  • profiles: enter multiple arrays (as an integer) on different lines
  • from: enter the date & time, e.g. 2017-03-24-12:57:45
  • to: enter the date & time, e.g. 2017-03-24-15:57:45

When you are ready, click the Try it out! button. The API will then return the appropriate response.

Pirawsessionmetricsdata2.png

Sessionsapi: CurrentSuccessRate

Sessions

This command is used to retrieve data on the amount of successful and failed sessions that are currently in use.

To access the command operations, click List Operations, then click the blue GET button to expand the operation. Alternatively, click Expand Operations to expand them all automatically.

Picurrentsuccessrate.png

Once expanded, you will be presented with an Example Value. Underneath this example, you must select the required Response Content Type from the dropdown list. Then enter the path/query parameters as required in the following fields:

  • profileId (required): enter the path as an integer
  • ScaleUnit: choose between minutes, hours or days
  • ScaleValue: enter the desired amount of time in relation to the chosen unit

When you are ready, click the Try it out! button. The API will then return the appropriate response.

Picurrentsuccessrate2.png

Launchers

This command is used to retrieve data on the amount of successful and failed sessions per launcher that are currently in use.

Once expanded, you will be presented with an Example Value. Underneath this example, you must select the required Response Content Type from the dropdown list. Then enter the path/query parameters as required in the following fields:

  • profileId (required): enter the path as an integer
  • launcheridentity(required): enter the launcher ID as a string
  • ScaleUnit: choose between minutes, hours or days
  • ScaleValue: enter the desired amount of time in relation to the chosen unit

When you are ready, click the Try it out! button. The API will then return the appropriate response.

Picurrentsuccessrate3.png

Servers

This command is used to retrieve data on the amount of successful and failed sessions per server that are currently in use.

Once expanded, you will be presented with an Example Value. Underneath this example, you must select the required Response Content Type from the dropdown list. Then enter the path/query parameters as required in the following fields:

  • profileId (required): enter the path as an integer
  • serverName (required): enter the sever name as a string
  • ScaleUnit: choose between minutes, hours or days
  • ScaleValue: enter the desired amount of time in relation to the chosen unit

When you are ready, click the Try it out! button. The API will then return the appropriate response.

Picurrentsuccessrate4.png

Workloadactionsapi: Actions

Workload actions

This command is used to retrieve data on workload actions and applications for different profiles.

To access the command operations, click List Operations, then click the blue GET button to expand the operation. Alternatively, click Expand Operations to expand them both automatically.

Workloadactions.png

Once expanded, you will be presented with an Example Value. Underneath this example, you must select the required Response Content Type from the dropdown list. Then enter the path/query parameters as required in the following fields:

  • profileId (required): enter the path as an integer

When you are ready, click the Try it out! button. The API will then return the appropriate response.

Workloadactions2.png

Category

This command is used to retrieve data on workload actions and applications per category for different profiles.

Once expanded, you will be presented with an Example Value. Underneath this example, you must select the required Response Content Type from the dropdown list. Then enter the path/query parameters as required in the following fields:

  • profileId (required): enter the path as an integer
  • category: choose between Appstart, CustomTimer or LogonAction

When you are ready, click the Try it out! button. The API will then return the appropriate response.

Workloadactions3.png