Start or stop a results database

Either start, stop or terminate a results database. The start and terminate actions are asynchronous and return a 202. A stop command is synchronous and returns a 200. See Asynchronous operations for details. In order to interact with a result database you need the results database ID. See Get an object for more information.

Path Params
integer
required

Uniquely identifies each results database.

Body Params
string
enum
required

Either start, stop, or terminate a results database object. Specify start to deploy a new results database server. You can stop to end the deployment process but leaves the server running. Or you can terminate to tear the server down.

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

stop command.

start or terminate action has been accepted, and is processing. This is an asynchronous process, see Asynchronous operations.

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.

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