See the API's various operations for details on their request parameters and response data.
| Operation | Method | Endpoint |
|---|---|---|
| Cloud servers | ||
| List cloud servers | GET | /CloudService/v1/cloudserver |
| Get a cloud server | GET | /CloudService/v1/cloudserver/{cloudserverId} |
| Restart or terminate a cloud server | POST | /CloudService/v1/cloudserver/{cloudserverId}/action |
| Test environments | ||
| Get a test environment | GET | /CloudService/v1/environment/{environmentId} |
| Start or stop a test environment | POST | /CloudService/v1/environment/{environmentId}/action |
| Grid provisioning | ||
| List grids | GET | /CloudService/v1/grid |
| Get a grid | GET | /CloudService/v1/grid/{gridId} |
| Start or stop a grid | POST | /CloudService/v1/grid/{gridId}/action |
| Compositions | ||
| List active compositions | GET | /composition/instances/v1 |
| Start or load a composition | POST | /composition/instances/v1 |
| Get a composition | GET | /composition/instances/v1/{instanceId} |
| Composition commands | PUT | /composition/instances/v1/{instanceId} |
| Objects | ||
| List objects | GET | /RepositoryService/v1/Objects/{type} |
| Create an object | PUT | /RepositoryService/v1/Objects/{type} |
| Delete an object | DELETE | /RepositoryService/v1/Objects/{type}/{objectId} |
| Get an object | GET | /RepositoryService/v1/Objects/{type}/{objectId} |
| Update an object | POST | /RepositoryService/v1/Objects/{type}/{objectId} |
| Transfer object ownership | POST | /owner/v1/mass-change-owner |
| Results management | ||
| List results management tasks | GET | /Results/management/v1 |
| Request a delete of test results | POST | /Results/management/v1 |
| Stop a results management task | DELETE | /Results/management/v1/{taskId} |
| Get a results management task | GET | /Results/management/v1/{taskId} |
| Query results | ||
| List results | GET | /Results/v1 |
| Get a result | GET | /Results/v1/{resultId} |
| Get ramp and marker data | GET | /Results/v1/{resultId}/Annotations |
| Get aggregate action data | GET | /Results/v1/{resultId}/clip-element |
| Get aggregate collection data | GET | /Results/v1/{resultId}/collection |
| List load generators | GET | /Results/v1/{resultId}/maestro-info |
| Get virtual user count | GET | /Results/v1/{resultId}/virtual-users |
| Get a virtual user count time series | GET | /Results/v1/{resultId}/virtual-users-by-interval |
| Results database | ||
| Get a results database | GET | /CloudService/v1/rsdb/{rsdbId} |
| Start or stop a results database | POST | /CloudService/v1/rsdb/{rsdbId}/action |
| Seed data | ||
| Delete seed data | DELETE | /RepositoryService/v1/SeedData/{seedDataId} |
| Get seed data | GET | /RepositoryService/v1/SeedData/{seedDataId} |
| Append seed data | POST | /RepositoryService/v1/SeedData/{seedDataId} |
| Server management | ||
| List servers | GET | /servermanagement/v1 |
| Get a server | GET | /servermanagement/v1/{serverId}/info |
| Tenant management | ||
| Initiate tenant sub-data deletion | POST | /tenant/management/delete/v1/{tenantId} |
| List tenant management tasks | GET | /tenant/management/v1 |
| Stop a tenant management task | DELETE | /tenant/management/v1/{taskId} |
| Get a tenant management task | GET | /tenant/management/v1/{taskId} |
| Tokens | ||
| Generate a token | PUT | /RepositoryService/v1/Tokens |
| Delete a token | DELETE | /RepositoryService/v1/Tokens/{tokenId} |