/dns/search_domains
POST https://api.sitehost.nz/1.3/dns/search_domains.json
Searches for domains
Form Parameters
Parameter | Type | Required | Description |
client_id | integer | Yes | The ID for the client that the domains belongs to.Example: 1 |
query[domain] | string | Yes | The query for searching the domainExample: example.nz |
offset[offset] | integer | The offset of the pageExample: 1 | |
offset[limit] | integer | The number of items to return per page.Example: 1 |
Code Samples
JavaScript PHP Rails Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "https://api.sitehost.nz/1.3/dns/search_domains.json", false);
var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("query[domain]", "example.nz");
data.append("offset[offset]", "1");
data.append("offset[limit]", "1");
xmlHttp.send(data);
var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/dns/search_domains.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'query[domain]' => 'example.nz',
'offset[offset]' => 1,
'offset[limit]' => 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.3/dns/search_domains.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,
"query[domain]" => "example.nz",
"offset[offset]" => 1,
"offset[limit]" => 1,
}
request.set_form_data(body)
response = http.request(request)
import requests
from collections import OrderedDict
uri = 'https://api.sitehost.nz/1.3/dns/search_domains.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['query[domain]'] = 'example.nz'
body['offset[offset]'] = 1
body['offset[limit]'] = 1
response = requests.post(uri, data=body)
Response
200:application/json
{
"return": [
{
"client_id": "1",
"name": "example.nz",
"template_id": "0"
}
],
"msg": "Successful.",
"status": true
}
"return": [
{
"client_id": "1",
"name": "example.nz",
"template_id": "0"
}
],
"msg": "Successful.",
"status": true
}