Login | Register
live chat
24/7 Emergency Hotline USA
Home Plugins/Modules SSL Certificates Prices Contacts
Download documentation
InternetBS.net → Reseller/Registrar Domain Name API → Domain Host List

Domain Host List

Resource path /Domain/Host/List

https://testapi.internet.bs/Domain/Host/List?apiKey=testapi&password=testpass&...

The command is intended to retrieve the list of hosts defined for a domain.
HTTPS POST/GET Request parameters:

Parameter name Description

ApiKey

The API key that we provided to you when you requested API access for your account

Password

The password we provided when you requested API access for your account

Domain

The domain name for which the list of hosts have to be retrieved

CompactList
(optional)

By default we only return the list of hosts. However you may obtain extra information such as IPs and host status if you set CompactList=no. The default value is ComptactList=yes.
Example list with CompactList=yes:
Host1=ns1.example.com
Host2=ns33.example2.com
Host3=example3.info
Host4=example4.biz

Example list with CompactList=no:
Host1=ns1.example.com
Host1_IPCount=2
Host1_IP1=194.1.2.3
Host1_IP2=194.1.2.4
Host2= ns2.example.com
Host2_IPCount=1
Host2_IP1=205.1.9.11

ResponseFormat
(optional)

This specifies how the response will be returned. Possible values are TEXT, JSON and XML.
The default value is TEXT however we encourage you to use JSON for easier result parsing (please refer to http://www.json.org for more details about JSON).

Returned data:

STATUS=SUCCESS or PENDING or FAILURE
TRANSACTID=Transaction ID
HOSTCOUNT =A value <N> representing the number of hosts found for the domain.
HOST1=hostname1.domain.tld
HOST1_IPCount=A value <X> representing the number of IP found for the host.
HOST1_IP1=IP
...
HOST1_IP<X>=IP
...
...
HOST<N>=hostnameN.domain.tld

Example:

https://testapi.internet.bs/Domain/Host/List?apiKey=testapi&password=testpass&domain=test-api-domain7.net


The result for this request is:

transactid=c83ac6a6be45f3198ac8204f7151f517
status=SUCCESS
total_hosts=5
host_1=ns1.test-api-domain7.net
host_2=ns2.test-api-domain7.net
host_3=ns3.test-api-domain7.net
host_4=ns4.test-api-domain7.net
host_5=ns5.test-api-domain7.net

Example 2 (with CompactList=no):

https://testapi.internet.bs/Domain/Host/List?apiKey=testapi&password=testpass&domain=test-api-domain7.net&CompactList=no

The result for this request is:

transactid=01806c59e8a5c0de1981a5148e2d9d29
status=SUCCESS
total_hosts=5
host_1_hostname=ns1.test-api-domain7.net
host_1_ipcount=2
host_1_ip_1=121.211.42.77
host_1_ip_2=144.222.21.92
host_2_hostname=ns2.test-api-domain7.net
host_2_ipcount=2
host_2_ip_1=121.211.42.77
host_2_ip_2=144.222.21.92
host_3_hostname=ns3.test-api-domain7.net
host_3_ipcount=2
host_3_ip_1=121.211.42.77
host_3_ip_2=144.222.21.92
host_4_hostname=ns4.test-api-domain7.net
host_4_ipcount=2
host_4_ip_1=121.211.42.77
host_4_ip_2=144.222.21.92
host_5_hostname=ns5.test-api-domain7.net
host_5_ipcount=2
host_5_ip_1=121.211.42.77
host_5_ip_2=144.222.21.92