POST https://api.sitehost.nz/1.1/server/update.json

Updates various configuration options of a server.

Form Parameters

client_idintegerYesThe ID for the client.Example: 1
namestringYesThe name of the server.Example: servername
updates[label]stringThe server label.Example: My Server
updates[notes]stringThe notes for the server.Example: This is a server.
updates[vnc_screen]stringThe default screen resolution for the server console.Example: 1024x768
updates[kernel]stringThe kernel for the server.Example: pvgrub-1.0-amd64
updates[partitions][][threshold]stringThe alert threshold in GB for a specific partition. This parameter accepts one or more values in the format of updates[partitions][xvda1][threshold]=1 where xvda1 is the name of each disk.Example: 1

Code Samples

JavaScript PHP Rails Python
var xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "https://api.sitehost.nz/1.1/server/update.json", false);

var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("name", "servername");
data.append("updates[label]", "My Server");
data.append("updates[notes]", "This is a server.");
data.append("updates[vnc_screen]", "1024x768");
data.append("updates[kernel]", "pvgrub-1.0-amd64");
data.append("updates[partitions][][threshold]", "1");


var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.1/server/update.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'name' => 'servername',
'updates[label]' => 'My Server',
'updates[notes]' => 'This is a server.',
'updates[vnc_screen]' => '1024x768',
'updates[kernel]' => 'pvgrub-1.0-amd64',
'updates[partitions][][threshold]' => '1',
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
require 'net/http'
require 'uri'

uri = URI.parse("https://api.sitehost.nz/1.1/server/update.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",
"updates[label]" => "My Server",
"updates[notes]" => "This is a server.",
"updates[vnc_screen]" => "1024x768",
"updates[kernel]" => "pvgrub-1.0-amd64",
"updates[partitions][][threshold]" => "1",

response = http.request(request)
import requests
from collections import OrderedDict

uri = 'https://api.sitehost.nz/1.1/server/update.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['updates[label]'] = 'My Server'
body['updates[notes]'] = 'This is a server.'
body['updates[vnc_screen]'] = '1024x768'
body['updates[kernel]'] = 'pvgrub-1.0-amd64'
body['updates[partitions][][threshold]'] = '1'

response = requests.post(uri, data=body)



  "msg": "Successful.",
  "status": true