/dns/list_domains


GET https://api.sitehost.nz/1.3/dns/list_domains.json

Lists all domains for a client.

Query Parameters

ParameterTypeRequiredDescription
client_idintegerYesThe ID for the client that the domains belong to.Example: 1
filters[domain]stringShows only domains that contain the string provided.Example: .co.nz
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.3/dns/list_domains.json?apikey=your_key_here&client_id=1&filters[domain]=.co.nz", false);

xmlHttp.send();

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/dns/list_domains.json?apikey=your_key_here&client_id=1&filters[domain]=.co.nz");
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.3/dns/list_domains.json?apikey=your_key_here&client_id=1&filters[domain]=.co.nz")
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.3/dns/list_domains.json?apikey=your_key_here&client_id=1&filters[domain]=.co.nz'

response = requests.get(uri)

Response

200:

application/json
{
    "return": {
        "total_items": 3,
        "current_items": 3,
        "current_page": 1,
        "total_pages": 1,
        "data": [
            {
                "name": "example.com",
                "client_id": "1",
                "template_id": "0",
                "pending": "0"
            },
            {
                "name": "example1.com",
                "client_id": "1",
                "template_id": "0",
                "pending": "0"
            },
            {
                "name": "example2.com",
                "client_id": "1",
                "template_id": "0",
                "pending": "1"
            }
        ]
    },
    "msg": "Successful.",
    "status": true
}