/server/list_allocated_ips


GET https://api.sitehost.nz/1.1/server/list_allocated_ips.json

Lists IP addresses allocated to a client.

Query Parameters

ParameterTypeRequiredDescription
client_idintegerYesThe ID for the client to list IP addresses for.Example: 1
vlan_idstringYesThe VLAN to list allocated IP addresses in.Example: 1
filters[addr_family]stringShow only IP addresses of a specific family.Example: 4
filters[sort_by]stringThe field name to sort the results by.
filters[sort_dir]stringThe direction to sort in. Valid options are ASC and DESC
filters[page_size]integerThe number of items to return per page.
filters[page_number]integerThe page number to return.

Code Samples

JavaScript PHP Rails Python
var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.1/server/list_allocated_ips.json?apikey=your_key_here&client_id=1&vlan_id=1&filters[addr_family]=4", false);

xmlHttp.send();

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.1/server/list_allocated_ips.json?apikey=your_key_here&client_id=1&vlan_id=1&filters[addr_family]=4");
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.1/server/list_allocated_ips.json?apikey=your_key_here&client_id=1&vlan_id=1&filters[addr_family]=4")
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.1/server/list_allocated_ips.json?apikey=your_key_here&client_id=1&vlan_id=1&filters[addr_family]=4'

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
}