Getting Started

The Micro Focus 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.

Supported Versions:

  • To improve the customer experience and provide more optimized search, the 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 relevant guide in the LoadRunner Enterprise Help Center.

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:

Run a test

See Start a Test Run.
Stop a run

See stop, stopNow, and abort.

Get run data

See Get Run Status, Get Extended Run Data, Get Run by Query, Runs (Get online summary data during a test run), Results (metadata), Results/{ID} (Results Reports), Results/{ID}/data (HTML report), and SLA (Get Status of Completed Run).

Define tests

See tests, testInstances (Create new instance in test set), testInstances (Get all test instances for TestID), Groups/{name}, Groups/{name}/RTS, Runtime Settings XML, tests/{ID}/validity, manage test sets, and manage test plan folders.

Upload/download scripts

See Scripts and Scripts/{ID}.

Manage hosts

See Managing Hosts, hosts , hosts/{hostID}, Get Hosts List by Query, and Get Docker Host Image.

Manage timeslot reservations

See timeslots, timeslots/{id}, timeslots/availabilities, and timeslot XML.

Manage trend reports

See TrendReports/{ID}, TrendReports/{ID}/data, TrendReports (Get all Trend Reports), TrendReports (Set Trend Reports Baseline), and TrendReports (Get Trend Report in XML format).

Manage resource folders

See Resources (Get all resource folders), Resources (Get resource folders by ID), Resources (Add resource folder), and Resources (Delete resource folder).

Manage version control

See Version Control (Get/Update version control status).

Note: LoadRunner Enterprise 2020 and later version do not support version control.

Manage monitors over a firewall

See Monitors over a Firewall (Get all), Monitors over Firewall (Get by ID), Monitors over a Firewall (Add), and Monitors over a Firewall (Delete).

Before your application closes, logout from the server.

Tip:  

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