Environments
Get Specific Environment
Gets the information for a single environment.
Permissions
User must be logged in. User must be a member of the environment.
Query Params
Param
Description
Optional/Required
id=[number]
id of the environment to get
Required
Success Response
Error Response
Get All Environments
Gets all of the information for all environments that the user has access to.
Permissions
User must be logged in.
Success Response
Error Response
Post a New Environment
Creates a new environment that can be used in the application. The environment will be used to house a collection of captures and replays.
Permissions
User must be logged in.
Body Params
Param
Description
Optional/Required
accessKey=[string]
Access key for AWS resource
Required
secretKey=[string]
Secret key for AWS resource
Required
region=[string]
Region assigned to AWS resource
Required
bucket=[string]
S3 bucket AWS resource
Required
dbName=[string]
Name of AWS DB resource
Required
host=[string]
Where the AWS server resource is
Required
user=[string]
Username for AWS resource
Required
pass=[string]
Password for AWS resource
Required
envName=[string]
Environment name to add AWS resource to
Required
instance=[string]
AWS EC2 instance
Required
parameterGroup=[string]
AWS DB container for engine configuration
Optional
keysName=[string]
Saves previously chosen AWS IAM credentials in placeholder
Optional
prefix=[string]
Optional directory name to store workload and metrics files in AWS S3 resource
Optional
Sample Request Body
Success Response
Error Response
Edit an Existing Environment
Modifies an existing environment.
Permissions
User must be logged in. User must be the environment admin.
Query Params
Param
Description
Optional/Required
id=[number]
id of the environment to edit
Required
Body Params
Param
Description
Optional/Required
accessKey=[string]
Access key for AWS resource
Required
secretKey=[string]
Secret key for AWS resource
Required
region=[string]
Region assigned to AWS resource
Required
bucket=[string]
S3 bucket AWS resource
Required
dbName=[string]
Name of AWS DB resource
Required
host=[string]
Where the AWS server resource is
Required
user=[string]
Username for AWS resource
Required
pass=[string]
Password for AWS resource
Required
envName=[string]
Environment name to add AWS resource to
Required
instance=[string]
AWS EC2 instance
Required
parameterGroup=[string]
AWS DB container for engine configuration
Optional
keysName=[string]
Saves previously chosen AWS IAM credentials in placeholder
Optional
prefix=[string]
Optional directory name to store workload and metrics files in AWS S3 resource
Optional
Sample Request Body
Success Response
Error Response
Delete an Environment
Removes an existing environment from the application.
Permissions
User must be logged in. User must be the environment admin.
Query Params
Param
Description
Optional/Required
id=[number]
id of the environment to edit
Required
Success Response
Error Response
Last updated