/server/upgrade


POST https://api.sitehost.nz/1.3/server/upgrade.json

Upgrades specific components of a server.

Form Parameters

ParameterTypeRequiredDescription
client_idintegerYesThe ID for the client.Example: 1
namestringYesThe name of the server.Example: servername
upgrade[cores]integerThe new number of cores for the server.Example: 1
upgrade[ram]stringThe new amount of RAM in GB for the server.Example: 1
upgrade[disk][0]integerThe new amount of disk space in GB for the server. This parameter accepts one or more values in the format of upgrade[disk][xvda1]=10 where xvda1 is the name of each disk.Example: 10

Code Samples

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

var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("name", "servername");
data.append("upgrade[cores]", "1");
data.append("upgrade[ram]", "1");
data.append("upgrade[disk][0]", "10");

xmlHttp.send(data);

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/server/upgrade.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'name' => 'servername',
'upgrade[cores]' => 1,
'upgrade[ram]' => '1',
'upgrade[disk][0]' => 10,
);
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/upgrade.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",
"upgrade[cores]" => 1,
"upgrade[ram]" => "1",
"upgrade[disk][0]" => 10,
}
request.set_form_data(body)

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

uri = 'https://api.sitehost.nz/1.3/server/upgrade.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['upgrade[cores]'] = 1
body['upgrade[ram]'] = '1'
body['upgrade[disk][0]'] = 10

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

Response

200:

application/json
{
  "return": {
    "cores": true,
    "disk": {
      "xvda2": true
    }
  },
  "msg": "Successful",
  "status": true
}