/server/add_ip


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

Adds an IP address to a server.

Form Parameters

ParameterTypeRequiredDescription
client_idintegerYesThe ID for the client that the server belongs to.Example: 1
namestringYesThe name of the server.Example: servername
paramstringYesThe IPv4 or IPv6 address to add.Example: 192.168.11.96

Code Samples

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

var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("name", "servername");
data.append("param", "192.168.11.96");

xmlHttp.send(data);

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.1/server/add_ip.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'name' => 'servername',
'param' => '192.168.11.96',
);
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.1/server/add_ip.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",
"param" => "192.168.11.96",
}
request.set_form_data(body)

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

uri = 'https://api.sitehost.nz/1.1/server/add_ip.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['param'] = '192.168.11.96'

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

Response

200:

application/json
{
  "return": {
    "ip_addr": "192.168.11.96"
  },
  "msg": "Successful",
  "status": true,
  "time": 46.61
}