Eggplant Performance Test Controller: REST API Method Summary Table

The REST API URLs and methods for working with Eggplant Performance Test Controller are listed in the following table, and the linked pages provide further information and examples.

note

Values surrounded by <angle brackets> on this page and the method information pages indicate values that you must provide according to your Eggplant Performance workspace setup (e.g. the workspace name).

If the values you provide in URL paths contain spaces or other special characters, they must be percent-encoded, e.g. /<workspace>/ would become /My%20Workspace/

Version

Title	HTTP Method	URL	Description
Version	GET	/test_controller/api/1.0/version	Gets the currently installed version of Eggplant Performance.

Workspace and project information

Title	HTTP Method	URL	Description
Workspace Information	GET	/test_controller/api/1.0	Gets information about the Eggplant Performance workspace.
Project Information	GET	/test_controller/api/1.0/<workspace>	Gets a list of the available projects within the specified workspace.
List Tests and Series	GET	/test_controller/api/1.0/<workspace>/<project>	Gets a list of the available tests and series within the specified project.
Test Information	GET	/test_controller/api/1.0/<workspace>/<project>/<test>	Gets the definition of a test.

Controlling test execution

To specify the test run, all of these method URLs begin with:

/test_controller/api/1.0/<workspace>/<project>/<test>

For brevity, these have been shortened in the following table.

Title	HTTP Method	URL	Description
Start Test Run	POST	.../<test>/start	Starts a new test run.
Stop Test Run at End of Iteration	POST	.../<test>/stop_at_end_of_iteration	Instructs all virtual users to stop at the end of the current iteration.
Stop Test Immediately	POST	.../<test>/stop_immediately	Instructs all virtual users to stop tests immediately.
Abort Test Run	POST	.../<test>/abort	Terminates all engine processes immediately.

Starting and stopping virtual users

Title	HTTP Method	URL	Description
Add Virtual Users	POST	.../<test>/add_virtual_users	Adds additional virtual users to the currently executing test run.
Stop Virtual Users At End of Iteration	POST	.../<test>/stop_virtual_users_at_end_of_iteration	Instructs some virtual users to stop at the end of the current iteration.
Stop Virtual Users Immediately	POST	.../<test>/stop_virtual_users_immediately	Instruct some virtual users to stop immediately.

Changing the pause factor

Title	HTTP Method	URL	Description
Set Pause Factor	POST	.../<test>/set_pause_factor	Updates the pause factor for one or more VU groups.

Test run status

To specify the test run, all of these method URLs begin with:

/test_controller/api/1.0/<workspace>/<project>/<test>

For brevity, these have been shortened in the following table.

Title	HTTP Method	URL	Description
Test Start Progress	GET	.../<test>/startup_progress	Gets progress messages for the startup of a test.
Test Closedown Progress	GET	.../<test>/closedown_progress	Gets progress messages for the closedown of a test
Test Run Status	GET	.../<test>/status	Gets the current status of the test run.
Test Status History	GET	.../<test>/status_history	Gets the test status over time.
Alerts	GET	.../<test>/alerts	Gets a list of all the alerts that have occurred during the test.
Injector Status	GET	.../<test>/injector_status	Gets the current status of the injectors in the test run
Available SUT Measurements	GET	.../<test>/sut_measurements	Gets the list of SUT measurements that are available for the current test run.
SUT Measurement	GET	.../<test>/sut_measurements/<SUT measurement>	Gets the values of a SUT measurement over the course of the test run.
Virtual User Group Counts	GET	.../<test>/virtual_user_group_counts	Gets the number of virtual users in each group, and their total.

Errors and warnings

To specify the test run, all of these method URLs begin with:

/test_controller/api/1.0/<workspace>/<project>/<test>

For brevity, these have been shortened in the following table.

Title	HTTP Method	URL	Description
Errors	GET	.../<test>/errors	Gets a list of all the errors that have occurred during the test.
Error Counts	GET	.../<test>/error_counts	Gets the cumulative error count over time.
Error Rates	GET	.../<test>/error_rates	Gets the error rate over time.
Warnings	GET	.../<test>/warnings	Gets a list of all the warnings that have occurred during the test.
Warning Counts	GET	.../<test>/warning_counts	Gets the cumulative warning count over time.
Warning Rates	GET	.../<test>/warning_rates	Gets the warning rate over time.

Timings and transactions

To specify the test run, all of these method URLs begin with:

/test_controller/api/1.0/<workspace>/<project>/<test>

For brevity, these have been shortened in the following table.

Title	HTTP Method	URL	Description
Timings	GET	.../<test>/timings	Gets a report on the timings that have been completed.
Timing Counts	GET	.../<test>/timings/counts	Gets the cumulative timing counts over time.
Timing Rates	GET	.../<test>/timings/rates	Gets the timing rates over time.
Timing Response Times	GET	.../<test>/timings/response_times	Gets the timing response times over time.
Transactions	GET	.../<test>/transactions	Gets a report on the transactions that have been completed.
Transaction Counts	GET	.../<test>/transactions/counts	Gets the cumulative transaction counts over time.
Transaction Rates	GET	.../<test>/transactions/rates	Gets the transaction rates over time.
Transaction Response Times	GET	.../<test>/transactions/response_times	Gets the transaction response times over time.

Metrics

To specify the test run, all of these method URLs begin with:

/test_controller/api/1.0/<workspace>/<project>/<test>

For brevity, these have been shortened in the following table.

Title	HTTP Method	URL	Description
Custom Metrics	GET	.../<test>/custom_metrics	Gets a list of the custom metrics that have been created for this test run.
Metric Averages	GET	.../<test>/metrics/averages	Gets the average value over time of a set of metrics.
Metric Counts	GET	.../<test>/metrics/counts	Gets the cumulative count over time of a set of metrics.
Metric Rate	GET	.../<test>/metrics/rates	Gets the rate over time of a set of metrics.
Metrics Concurrency	GET	.../<test>/metrics/concurrency	Gets the counts of concurrent metrics for multiple running VUs over time.
Metric Total Rates	GET	.../<test>/metrics/total_rates	Gets the total rates over time of a set of metrics.
Metric Totals	GET	.../<test>/metrics/totals	Gets the total passed and failed counts over time of a set of metrics.

Shared Data Server

These methods can be used to interact with the Shared Data Server.

Title	HTTP Method	URL	Description
Get	GET	/test_controller/api/1.0/shared_data_server/get	Reads the value associated with the specified key.
Set	POST	/test_controller/api/1.0/shared_data_server/set	Creates or modifies the value associated with the specified key.
Increment	POST	/test_controller/api/1.0/shared_data_server/increment	Increments an integer value associated with the specified key.
Decrement	POST	/test_controller/api/1.0/shared_data_server/decrement	Decrements an integer value associated with the specified key.
Clear	POST	/test_controller/api/1.0/shared_data_server/clear	Clears all values associated with the specified key.
Clear All	POST	/test_controller/api/1.0/shared_data_server/clear_all	Clears all keys and values.