API

Start or stop a test environment

post
https://{hostname}/concerto/services/rest/CloudService/v1/environment//action

Either start or stop a test environment. The operation responds either synchronously with a 200 code, or asynchronously with 202. See Asynchronous operations for details.

Path Params
integer
required

Uniquely identifies each test environment.

Body Params

Action to take on an environment.

string
enum
required

Specify start to deploy servers that make up the environment through the cloud provider. You can stop the deployment process without tearing down any servers. Set terminate to tear down the environment, which terminates the servers but has no effect on grid servers. Or you can format a new and previously formatted volume.

Allowed:
Headers
string
required

All calls to this API require that you pass in the token you get from the Generate a token operation as an X-Auth-Token request header. See Get started for help to initially call the API.

Responses

400

Bad request. The URL or JSON request object is invalid.

401

Unauthorized. The security token is missing or invalid. See Get started for help initially running the API.

404

Not found. The requested object doesn't exist.

405

Method Not Allowed. Invalid method used to access resource.

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago