Getting Started

The LoadRunner Enterprise Administration REST API enables you to write applications to manage performance test resources without using the LoadRunner Enterprise Administration user interface. This API provides only a subset of the functionality provided by the user interface.

Supported Versions:

  • To improve the customer experience and provide more optimized search, the Micro Focus LoadRunner Enterprise REST API References (formerly Performance Center) 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 Administration section in the Micro Focus LoadRunner Enterprise Help Center.

Before accessing any other resource, you must authenticate the user. See Authenticate.

Once the user is authenticated, you can:

Manage hostsSee hosts, hosts/{hostID}, and Get Hosts List by Query.
Manage cloud hostsSee Provision cloud hosts, Deprovision cloud hosts, Get provision request, Get all provision requests, Provision host response, Get all cloud hosts, Audit cloud hosts, and Get Cloud Account.
Manage poolsSee host pools, host pools/{poolID}, and Get Host Pool List by Query.
Get run dataSee Get all runs and Get Run by Query.
Manage projectsSee projects (Get Projects), projects (Create a project), projects/{projectID}, projects (Get by Query), and projects (Remove Projects).
Manage licenses

See licenses (Get licenses), licenses/{licenseID}, Get Licenses by Query, and licenses (Get license summary).

Manage MI ListenersSee MI Listeners (Get MI Listeners), MI Listeners/{milistenersID}, and Get MI Listeners by Query.
Manage UsersSee users (Add a user), users (Update a user), users (Delete a user), assignUser (Assign user to project and role), users (Get user by ID), users (Get all users), and users (Get list of users by query).

Before your application closes, logout from the server.

Tip:  To write applications to create and run performance tests without using the LoadRunner Enterprise user interface, see the Micro Focus LoadRunner Enterprise REST API Reference Guide.

Notes

  • 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.

See Also