Recipes
Authenticates and generates a token. The security token expires after five hours of inactivity.
- Specify a username
- Specify your password
- Specify the apiToken
- 🦉
Generate a token
Authenticates and generates a token. The security token expires after five hours of inactivity.
6 stepsOpen Recipe - 🦉
List active compositions
Get all instances that are in some type of active state. After tests are complete the instances are unloaded and the API can no longer return them, these are considered inactive. Because this call uses an asynchronous process to get the list of instances, if there are many load generators you should run a second call to ensure you get the most complete list of instances.
3 stepsOpen Recipe - 🦉
Composition commands
The composition commands you use on a test instance are: play, stop, abort, pause, resume, unload. The return of the command doesn't imply that the action is complete. To get the current state of the instance, use the Get a composition command.
5 stepsOpen Recipe - 🦉
List servers
Get a list of all servers listed in the server list. You need to have server access privileges to access this operation.
3 stepsOpen Recipe - 🦉
Get a server
Returns server info for the specified server. You need to have server access privileges to access this operation.
4 stepsOpen Recipe - 🦉
Restart or terminate a cloud server
restartorterminatea cloud server. The operation responds asynchronously with 202, see Asynchronous operations for details.6 stepsOpen Recipe - 🦉
List grids
Returns an array of grids. Retrieves a list of Grids that have been started. It may include
TERMINATEDgrids. It doesn't return grids that exist in the repository but are inactive.3 stepsOpen Recipe - 🦉
Start or stop a grid
Start or stopt a grid. The operation responds either synchronously with a 200 code, or asynchronously with 202. See Asynchronous operations for details.
5 stepsOpen Recipe - 🦉
Start or stop a test environment
startorstopa test environment. The operation responds either synchronously with a 200 code, or asynchronously with 202. See Asynchronous operations for details.5 stepsOpen Recipe - 🦉
Get a results database
Returns a single rsdb. In order to interact with a result database you need the results database ID. See Get an object for more information.
4 stepsOpen Recipe - 🦉
Start or stop a results database
start,stoporterminatea results database. The start and terminate actions are asynchronous and return a 202. A stop command is synchronous and returns a 200. See Asynchronous operations for details. In order to interact with a result database you need the results database ID. See Get an object for more information.1 stepOpen Recipe - 🦉
Get aggregate collection data
Queries collection related metrics (pages, transactions, etc.) from a result with grouping/aggregation by location, time in seconds or minutes, network profile, element type, or element name. Use this to determine page load time or transactions per second (tps) or get the 90th percentile for a transaction.
5 stepsOpen Recipe - 🦉
Get aggregate collection data by multiple groups
Queries collection related metrics (pages, transactions, etc.) from a result with grouping/aggregation by location, time in seconds or minutes, network profile, element type, or element name. Use this to determine page load time or transactions per second (tps) or get the 90th percentile for a transaction.
5 stepsOpen Recipe - 🦉
Request a delete of test results
This action submits a background task to delete results. It returns a jobId. Use the jobId to make subsequent calls to track the status of the task.
4 stepsOpen Recipe

