/cloud/stack/stop
POST https://api.sitehost.nz/1.0/cloud/stack/stop.json
Requests to stop a stack.
Form Parameters
Parameter | Type | Required | Description |
client_id | integer | Yes | The ID for the client that the stack belongs to.Example: 1 |
server | string | Yes | The server where the stack resides.Example: ch-servername |
name | string | Yes | The name of the stack to stop.Example: examplenz |
containers[] | string | A list of individual containers in the stack to stop. This parameter accepts one or more values in the format of containers[]=x, containers[]=y.Example: example.nz |
Code Samples
JavaScript PHP Rails Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "https://api.sitehost.nz/1.0/cloud/stack/stop.json", false);
var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("server", "ch-servername");
data.append("name", "examplenz");
data.append("containers[]", "example.nz");
xmlHttp.send(data);
var response = xmlHttp.responseText;
Response
200:application/json
{
"return": {
"job_id": "3433562"
},
"msg": "Successful",
"status": true,
"time": 29.92
}
"return": {
"job_id": "3433562"
},
"msg": "Successful",
"status": true,
"time": 29.92
}