LoadView has an easy-to-use API that provides access to the LoadView Test datasets. Leverage simple HTTP(S) requests to the LoadView API to query stress test data and results, clone existing tests, and run or abort a stress test. You can develop a software application that uses LoadView capabilities or integrate LoadView service functionality into your own environment. This article gives you a general introduction to the LoadView API methods available to create the custom requests.
Available Methods
You need to be authenticated before any API request. Authentication expires after 60 seconds of inactivity.
The table below shows which actions are supported.
| Request Method | URI(s) | Description |
|---|---|---|
| GET | /StressTest | Return the list of available tests. |
| GET | /StressTest/{id}/Clone | Create a new test by cloning the existed one. |
| POST | /StressTest/{id}/Run | Start a test. Change the status of the test to RUN. |
| GET | /StressTest/{id}/AbortTest | Abort test execution at any stage. Change the status of the test to AbortTest.
No test results are returned. |
| GET | /StressTest/{id}/StopLoad | Stop load emulation. Change the status of the test to StopLoad. |
| GET | /StressTest/{id}/Result | Get the test results by ID. |
| GET | /StressTest/{id} | Get the test settings by ID. |
| GET | /GroupStressTest | Get a list of Stress Groups. |
| GET | /GroupStressTest/{GroupID}/config | Get Stress Group info. |
| GET | /GroupStressTest/{GroupID}/result | Get Stress Group results. |
| POST | /GroupStressTest/Run | Start the group of load tests and change their status to RUN. |
| GET | /GroupStressTest/{GroupID}/AbortTest | Abort execution of the tests included in the stress group with the specified id and change their status to AbortTest. No tests results are returned. |
| GET | /GroupStressTest/{GroupID}/StopLoad | Stop load emulation for the stress group with the specified id. Results that have been received during the tests execution period will be available. |
Error Handling
Upon receiving both API method errors or errors generated when a test was not started due to exceeding package limits or absence of available LIs, the LoadView API returns an HTTP code 400. For more information, see Error Handling.