API summary

See the API's various operations for details on their request parameters and response data.

OperationMethodEndpoint
Cloud servers
List cloud serversGET/CloudService/​v1/​cloudserver
Get a cloud serverGET/CloudService/​v1/​cloudserver/​{cloudserverId}
Restart or terminate a cloud serverPOST/CloudService/​v1/​cloudserver/​{cloudserverId}/​action
Test environments
Get a test environmentGET/CloudService/​v1/​environment/​{environmentId}
Start or stop a test environmentPOST/CloudService/​v1/​environment/​{environmentId}/​action
Grid Provisioning
List gridsGET/CloudService/​v1/​grid
Get a gridGET/CloudService/​v1/​grid/​{gridId}
Start or stop a gridPOST/CloudService/​v1/​grid/​{gridId}/​action
Compositions
List active compositionsGET/composition/​instances/​v1
Start or load a compositionPOST/composition/​instances/​v1
Get a compositionGET/composition/​instances/​v1/​{instanceId}
Composition commandsPUT/composition/​instances/​v1/​{instanceId}
Objects
List objectsGET/RepositoryService/​v1/​Objects/​{type}
Create an objectPUT/RepositoryService/​v1/​Objects/​{type}
Delete an objectDELETE/RepositoryService/​v1/​Objects/​{type}/​{objectId}
Get an objectGET/RepositoryService/​v1/​Objects/​{type}/​{objectId}
Update an objectPOST/RepositoryService/​v1/​Objects/​{type}/​{objectId}
Results management
List results management tasksGET/Results/​management/​v1
Request a delete of test resultsPOST/Results/​management/​v1
Stop a results management taskDELETE/Results/​management/​v1/​{taskId}
Get a results management taskGET/Results/​management/​v1/​{taskId}
Query results
List resultsGET/Results/​v1
Get a resultGET/Results/​v1/​{resultId}
Get ramp and marker dataGET/Results/​v1/​{resultId}/​Annotations
Get aggregate action dataGET/Results/​v1/​{resultId}/​clip-element
Get aggregate collection dataGET/Results/​v1/​{resultId}/​collection
List load generatorsGET/Results/​v1/​{resultId}/​maestro-info
Get virtual user countGET/Results/​v1/​{resultId}/​virtual-users
Get a virtual user count time seriesGET/Results/​v1/​{resultId}/​virtual-users-by-interval
Results database
Get a results databaseGET/CloudService/​v1/​rsdb/​{rsdbId}
Start or stop a results databasePOST/CloudService/​v1/​rsdb/​{rsdbId}/​action
Seed data
Delete seed dataDELETE/RepositoryService/​v1/​SeedData/​{seedDataId}
Get seed dataGET/RepositoryService/​v1/​SeedData/​{seedDataId}
Append seed dataPOST/RepositoryService/​v1/​SeedData/​{seedDataId}
Server management
List serversGET/servermanagement/​v1
Get a serverGET/servermanagement/​v1/​{serverId}/​info
Tenant management
Initiate tenant sub-data deletionPOST/tenant/​management/​delete/​v1/​{tenantId}
List tenant management tasksGET/tenant/​management/​v1
Stop a tenant management taskDELETE/tenant/​management/​v1/​{taskId}
Get a tenant management taskGET/tenant/​management/​v1/​{taskId}
Tokens
Generate a tokenPUT/RepositoryService/​v1/​Tokens
Delete a tokenDELETE/RepositoryService/​v1/​Tokens/​{tokenId}