/cloud/server/set_update_window


POST https://api.sitehost.nz/1.2/cloud/server/set_update_window.json

Set the automatic Container Maintenance schedule for a managed Cloud Containers server.

Form Parameters

ParameterTypeRequiredDescription
client_idintegerYesThe ID for the client that the servers belong to.Example: 1
server_namestringYesThe name of the managed server.Example: ch-servername
enabledintegerTo enable or disable the maintenance.
0=Disable, 1=EnableExample: 1
day_of_weekintegerYesThe day of week to run the maintenance. Valid options are 0-6 where 0 is Monday and 6 is Sunday.Example: 1
hour_of_dayintegerYesThe hour of day to run the maintenance. Valid options are 0-23.Example: 1
minute_of_hourintegerYesThe minute of hour to run the maintenance. Valid options are 0-59.Example: 1

Code Samples

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

var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("server_name", "ch-servername");
data.append("enabled", "1");
data.append("day_of_week", "1");
data.append("hour_of_day", "1");
data.append("minute_of_hour", "1");

xmlHttp.send(data);

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.2/cloud/server/set_update_window.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'server_name' => 'ch-servername',
'enabled' => 1,
'day_of_week' => 1,
'hour_of_day' => 1,
'minute_of_hour' => 1,
);
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.2/cloud/server/set_update_window.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,
"server_name" => "ch-servername",
"enabled" => 1,
"day_of_week" => 1,
"hour_of_day" => 1,
"minute_of_hour" => 1,
}
request.set_form_data(body)

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

uri = 'https://api.sitehost.nz/1.2/cloud/server/set_update_window.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['server_name'] = 'ch-servername'
body['enabled'] = 1
body['day_of_week'] = 1
body['hour_of_day'] = 1
body['minute_of_hour'] = 1

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

Response

200:

application/json
{
  "msg": "Successful.",
  "status": true
}