Share this page

# Getting started

This topic introduces the OpenText™ Enterprise Performance Engineering REST API and provides some tips about getting started.

## About REST APIs

The OpenText Enterprise Performance Engineering Admin REST API enables you to write applications to manage performance test resources without using the product 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 REST API references are now version-less. Any version specific changes are indicated where relevant.

While this guide specifically supports versions 12.60 and later, most APIs listed here are also supported in earlier versions.

This document does not define the terms used in the context of OpenText Enterprise Performance Engineering Admin. For details, see the Administration section in the OpenText Enterprise Performance Engineering Help Center.

Note: For details on creating and running performance tests using the APIs, see the REST API Reference Guide.

## API functions

The following is a list of the API functions that you can use with OpenText Enterprise Performance Engineering Admin.

Authenticate the user | Before accessing any other resource, you must authenticate the user. See Authenticate. Once the user is authenticated, you can perform the actions listed below.
Manage hosts | Add hosts and return list of hosts Return, delete, reconfigure, or update a host by ID Get hosts list by query Hosts response
Manage cloud hosts | Provision cloud hosts Deprovision cloud hosts Get provision request Get all provision requests Provision host response Get all cloud hosts Audit cloud hosts Get cloud account Provision host response
Manage configurations | Get public key Generate new key pair
Manage pools | Host pools Return, update, or delete a host pool by ID Get host pool list by query
Get run data | Get all runs Get runs by query
Manage projects | Get all projects Create a project Get or update project by project ID Get projects by query Remove projects Test database connection to a project (Oracle environments only) Update database connection to a project (Oracle environments only)
Manage licenses | Get licenses Get license by ID Get licenses by query Get license summary
Manage MI Listeners | Add MI Listeners Get MI Listeners Get MI Listeners by ID Get MI Listeners by query
Manage users | Add a user Update a user Change a user's password Delete a user Assign project and role to user Unassign user from projects Get user by ID Get all users Get list of users by query
Manage timeslots | Limit advance timeslot reservations
Manage monitors | Add or update a monitor system token Delete a monitor system token
Logout | Before your application closes, logout from the server.

## Notes for API calls

The following notes apply to OpenText Enterprise Performance Engineering Admin 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 "ADM_LWSSO" (in versions 2020 and later) or "LWSSO_COOKIE_KEY" (in versions earlier than 2020) can result in authentication expiration while the user is interacting with the REST API service.

- For versions 25.1 and higher: The response to an authentication request contains a cookie with a path pointing to the request's root base path. Any subsequent requests must be persistent with the root base path, with case sensitivity.

  For example, if the original authentication request used the value /Admin as the root base path, the cookie's path will be set to that value. If you send a subsequent request with a different case, such as /admin, the HTTP client will not append the cookie to the request's header, resulting in a forbidden response.

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

See also:

- Blog: Introduction to the Performance Center REST API
- Blog: How to create a new performance test using PC REST API

Tips to improve your search results... OpenText™ Enterprise Performance Engineering Admin API Reference OpenText™ Enterprise Performance Engineering All View Local Help Center View Online Help Center(Undefined variable: _rscC_Basic_Variables.VersionLabel)