Share this page
Introducing LoadRunner Enterprise REST APIs
This topic introduces the LoadRunner Enterprise REST API and provides some tips about getting started.
About LoadRunner Enterprise REST APIs
The LoadRunner Enterprise REST API enables you to write applications to create and run performance tests without using the LoadRunner Enterprise user interface.
This API provides only a subset of the functionality provided by the user interface.
About the REST API documentation
To improve the customer experience and provide more optimized search, the LoadRunner Enterprise REST API References are now version-less. Any version specific changes are indicated where relevant.
While this guide specifically supports LoadRunner Enterprise versions 12.60 and later, most APIs listed here are also supported in earlier versions of LoadRunner Enterprise.
This document does not define the terms used in the context of LoadRunner Enterprise. For details, see the relevant guide in the LoadRunner Enterprise Help Center.
Note: For details on managing performance test resources using LoadRunner Enterprise Administration APIs, see the LoadRunner Enterprise Administration REST API Reference Guide.
API functions
The following is a list of the API functions that you can use with LoadRunner Enterprise:
| Action | Topic Links |
|---|---|
Authenticate the user | Before accessing any other resource, you must authenticate the user. See Authenticate. You can also get the domains list and projects list for a domain for the authenticated user. Once the user is authenticated, you can perform the actions listed below. |
Run a test | Start a test run |
| Stop a run | |
| Get run data | Get online summary data during a test run Start a late analyze for a run |
| Define tests | Create new instance in test set Get all test instances by test ID Add, update, or remove a group from a test |
| Manage scripts | |
| Manage hosts | |
| Manage cloud hosts | |
| Manage timeslot reservations | |
| Manage trend reports | |
| Manage resource folders | |
| Manage version control | Get or update version control status. Note: LoadRunner Enterprise 2020 and later version do not support version control. |
| Manage monitors over a firewall | Get all monitors over a firewall Get monitors over firewall by ID Add a monitor over a firewall Delete a monitor over a firewall |
| Logout | Before your application closes, logout from the server. |
Available in versions 12.6x or earlier: The LoadRunner Enterprise REST API can be used with the ALM REST API. The ALM REST API Reference is available from the ALM Help Center.
Notes for API calls
The following notes apply to LoadRunner Enterprise REST APIs:
- The REST API cannot run in a configuration where a proxy server requires Basic Authentication before allowing access to the REST resources.
- If server performance degrades when using this API, check whether your application is causing several process-intensive tasks to run at the same time. If so, change the timing of these calls to reduce the server loading.
- In any request you send to the server, return all cookies sent by the server in the preceding response using "Set-Cookie". Failing to resend the "LWSSO_COOKIE_KEY" can result in authentication expiration while the user is interacting with the REST API service.
- Project names, domain names, and any other resource that is passed as a query parameter in a public API cannot contain Microsoft Windows reserved words, such as COM1-9, LPT1-9, AUX, PRT, NUL, and CON.
- For all POST requests, the default Content-Type is
application/xml. - For all requests that return data, the default Accept is
application/xml. - For application exceptions, see Exceptions.
See also:
