List zones

Description

Gets a list with zones you have or zone names matching a keyword. The method works with pagination. Reverse zones are included.


 Parameters

Name Data Type Status  Description
auth-id or sub-auth-id or sub-auth-user Integer Required Authentication parameter
auth-password String Required Authentication parameter
page Integer Required Current page your zone list is on
rows-per-page Integer Required Results per page. Can be 10, 20, 30, 50 or 100.
search String Optional Domain name, reverse zone name or keyword to search for in the zone names
group-id Integer Optional ID of the relevant group. If group's ID is set up, all zones in this group will be listed. If value none is set up for parameter group-id, all not included zones in this group will be listed.

Return: Array with the found zones.


Errors

If only authentication parameters are sent or page parameter is not Integer, the API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Missing required parameter 'page'."}

When only authentication and page parameters are sent or rows-per-page paremeter is not Integer, the API request will fail and the following status and statusDescription will be returned:

{"status":"Failed","statusDescription":"Wrong or missing required parameter 'rows-per-page'."}

Note: These are example errors in JSON format.


Example

URL JSON: https://api.cloudns.net/dns/list-zones.json
POST/GET: auth-id=0&auth-password=password&page=1&rows-per-page=10
POST/GET: sub-auth-id=0&auth-password=password&page=1&rows-per-page=10

URL XML: https://api.cloudns.net/dns/list-zones.xml
POST/GET: auth-id=0&auth-password=password&page=1&rows-per-page=10
POST/GET: sub-auth-id=0&auth-password=password&page=1&rows-per-page=10

Example for zone search

URL JSON: https://api.cloudns.net/dns/list-zones.json
Domain POST/GET:
auth-id=0&auth-password=password&page=1&rows-per-page=10&search=domain-name
sub-auth-id=0&auth-password=password&page=1&rows-per-page=10&search=domain-name
Reverse zone POST/GET:
auth-id=0&auth-password=password&page=1&rows-per-page=10&search=0.0.127.in-addr.arpa
sub-auth-id=0&auth-password=password&page=1&rows-per-page=10&search=0.0.127.in-addr.arpa

URL XML: https://api.cloudns.net/dns/list-zones.xml
Domain POST/GET:
auth-id=0&auth-password=password&page=1&rows-per-page=10&search=domain-name
sub-auth-id=0&auth-password=password&page=1&rows-per-page=10&search=domain-name
Reverse zone POST/GET:
auth-id=0&auth-password=password&page=1&rows-per-page=10&search=0.0.127.in-addr.arpa
sub-auth-id=0&auth-password=password&page=1&rows-per-page=10&search=0.0.127.in-addr.arpa 

Example for zone search filtered by groups

URL JSON: https://api.cloudns.net/dns/list-zones.json
Domain POST/GET:
auth-id=0&auth-password=password&page=1&rows-per-page=10&group-id=id
sub-auth-id=0&auth-password=password&page=1&rows-per-page=10&group-id=id

URL XML: https://api.cloudns.net/dns/list-zones.xml
Domain POST/GET:
auth-id=0&auth-password=password&page=1&rows-per-page=10&group-id=id
sub-auth-id=0&auth-password=password&page=1&rows-per-page=10&group-id=id

 


Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more