See the API's various operations for details on their request parameters and response data.
You can also run this API with a Postman collection.
| Operation | Method | Endpoint |
|---|---|---|
| Test runs | ||
| List test runs | GET | /test-runs |
| Submit a test run | POST | /test-runs |
| Get a test run | GET | /test-runs/{testRunId} |
| Get test run's detailed results | GET | /test-runs/{testRunId}/raw-request-response |
| Functional testing | ||
| List test suites | GET | /functional/test-suites |
| Create a test suite | POST | /functional/test-suites |
| Generate a test suite with child objects | POST | /functional/test-suites/auto-generate |
| Create a test suite with child objects | POST | /functional/test-suites/with-child-objects |
| Delete a test suite | DELETE | /functional/test-suites/{testSuiteId} |
| Get a test suite | GET | /functional/test-suites/{testSuiteId} |
| Update a test suite | PUT | /functional/test-suites/{testSuiteId} |
| Restore a test suite | POST | /functional/test-suites/{testSuiteId}/restore |
| List test cases | GET | /functional/test-suites/{testSuiteId}/test-cases |
| Add test cases to a test suite | POST | /functional/test-suites/{testSuiteId}/test-cases |
| Update test cases | PUT | /functional/test-suites/{testSuiteId}/test-cases |
| Reorder test cases in a test suite | PUT | /functional/test-suites/{testSuiteId}/test-cases/order |
| Remove test cases | POST | /functional/test-suites/{testSuiteId}/test-cases/remove |
| Restore test cases | POST | /functional/test-suites/{testSuiteId}/test-cases/restore |
| Get a test case | GET | /functional/test-suites/{testSuiteId}/test-cases/{testCaseId} |
| List variables | GET | /functional/test-suites/{testSuiteId}/variables |
| Add variables to a test suite | POST | /functional/test-suites/{testSuiteId}/variables |
| Update variables | PUT | /functional/test-suites/{testSuiteId}/variables |
| Delete variables | POST | /functional/test-suites/{testSuiteId}/variables/remove |
| Get a variable | GET | /functional/test-suites/{testSuiteId}/variables/{variableId} |
| Get a test suite with child objects | GET | /functional/test-suites/{testSuiteId}/with-child-objects |
| Update a test suite with child objects | PUT | /functional/test-suites/{testSuiteId}/with-child-objects |
| Test catalog template | ||
| List test conditions | GET | /functional/test-catalog/conditions |
| Get the test catalog template | GET | /functional/test-catalog/template |
| Test requests | ||
| List test requests | GET | /functional/test-requests |
| Functions | ||
| Check how functions work | POST | /functional/functions/try-it |