/server/list_allocated_i_ps
GET https://api.sitehost.nz/1.2/server/list_allocated_i_ps.json
Lists IP addresses allocated to a client.
Query Parameters
Parameter | Type | Required | Description |
client_id | integer | Yes | The ID for the client to list IP addresses for.Example: 1 |
vlan_id | string | Yes | The VLAN to list allocated IP addresses in.Example: 1 |
filters[addr_family] | string | Show only IP addresses of a specific family.Example: 4 | |
map_addresses[0] | string | Show addresses mapped to provided list of IPs. Can provide multiple inputs like map_addresses[1]=192.168.0.1Example: 192.168.0.1 | |
filters[sort_by] | string | The field name to sort the results by. | |
filters[sort_dir] | string | The direction to sort in. Valid options are ASC and DESC | |
filters[page_size] | integer | The number of items to return per page. | |
filters[page_number] | integer | The page number to return. |
Code Samples
JavaScript PHP Rails Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.2/server/list_allocated_i_ps.json?apikey=your_key_here&client_id=1&vlan_id=1&filters[addr_family]=4&map_addresses[0]=192.168.0.1", false);
xmlHttp.send();
var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.2/server/list_allocated_i_ps.json?apikey=your_key_here&client_id=1&vlan_id=1&filters[addr_family]=4&map_addresses[0]=192.168.0.1");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$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/server/list_allocated_i_ps.json?apikey=your_key_here&client_id=1&vlan_id=1&filters[addr_family]=4&map_addresses[0]=192.168.0.1")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Get.new(uri.request_uri)
response = http.request(request)
import requests
uri = 'https://api.sitehost.nz/1.2/server/list_allocated_i_ps.json?apikey=your_key_here&client_id=1&vlan_id=1&filters[addr_family]=4&map_addresses[0]=192.168.0.1'
response = requests.get(uri)
Response
200:application/json
{
"return": {
"total_items": 2,
"current_items": 2,
"current_page": 1,
"total_pages": 1,
"data": {
"192.168.7.32": {
"ip_addr": "192.168.7.32",
"netmask": "255.255.255.0",
"prefix": "32",
"reserved": "0",
"rdns": "rdns.192.168.7.32.sth.nz",
"addr_family": "4",
"date_allocated": "2016-09-05 13:19:19",
"server_id": "202",
"name": "servername",
"label": "My Server Label",
"is_primary": "1",
"ip_type": "1"
},
"192.168.7.33": {
"ip_addr": "192.168.7.33",
"netmask": "255.255.255.0",
"prefix": "32",
"reserved": "0",
"rdns": "rdns.192.168.7.33.sth.nz",
"addr_family": "4",
"date_allocated": "2016-09-05 13:23:59"
}
}
},
"msg": "Successful",
"status": true
}
"return": {
"total_items": 2,
"current_items": 2,
"current_page": 1,
"total_pages": 1,
"data": {
"192.168.7.32": {
"ip_addr": "192.168.7.32",
"netmask": "255.255.255.0",
"prefix": "32",
"reserved": "0",
"rdns": "rdns.192.168.7.32.sth.nz",
"addr_family": "4",
"date_allocated": "2016-09-05 13:19:19",
"server_id": "202",
"name": "servername",
"label": "My Server Label",
"is_primary": "1",
"ip_type": "1"
},
"192.168.7.33": {
"ip_addr": "192.168.7.33",
"netmask": "255.255.255.0",
"prefix": "32",
"reserved": "0",
"rdns": "rdns.192.168.7.33.sth.nz",
"addr_family": "4",
"date_allocated": "2016-09-05 13:23:59"
}
}
},
"msg": "Successful",
"status": true
}