/server/change_state
POST https://api.sitehost.nz/1.3/server/change_state.json
Changes the state of a server.
Form Parameters
Parameter | Type | Required | Description |
client_id | integer | Yes | The ID for the client that the server belongs to.Example: 1 |
name | string | Yes | The name of the server.Example: servername |
state | string | Yes | The new server state. The following values are accepted: power_on, power_off, rescue_on, rescue_off, rebootExample: power_off |
Code Samples
JavaScript PHP Rails Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "https://api.sitehost.nz/1.3/server/change_state.json", false);
var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("name", "servername");
data.append("state", "power_off");
xmlHttp.send(data);
var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/server/change_state.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'name' => 'servername',
'state' => 'power_off',
);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
require 'net/http'
require 'uri'
uri = URI.parse("https://api.sitehost.nz/1.3/server/change_state.json")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri)
body = {"apikey" => "your_key_here",
"client_id" => 1,
"name" => "servername",
"state" => "power_off",
}
request.set_form_data(body)
response = http.request(request)
import requests
from collections import OrderedDict
uri = 'https://api.sitehost.nz/1.3/server/change_state.json'
# We need ordered dictionary because parameters have to be in the right order.
# Refer to Developer Notes for more information.
body = OrderedDict()
body['apikey'] = 'your_key_here'
body['client_id'] = 1
body['name'] = 'servername'
body['state'] = 'power_off'
response = requests.post(uri, data=body)
Response
200:application/json
{
"return": {
"job_id": "3433562"
},
"msg": "Successful",
"status": true
}
"return": {
"job_id": "3433562"
},
"msg": "Successful",
"status": true
}