List records

Description

List of records in the domain zone

Note: This function is available only for master zones. Works with reverse zones, too.


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
domain-name String Required A domain name or reverse zone name whose record you want to see
host String Optional A host of the records you want to list
host-like String Optional An optional parameter for a non-exact match search. If this parameter is in use, the host parameter will be ignored.
type String Optional Type of the records you want to list (record types)
rows-per-page Integer Optional Results per page. Can be 10, 20, 30, 50 or 100
page Integer Optional The page number you want to check
order-by String Optional An optional parameter for sorting the records. Can be either host or points-to.
include-notes Integer Optional

0 - if you don't want to receive the notes for the records.

1 - if you want to see the notes for the records in the list. Currently this is the default option. In July 2027 it will be set to 0, so make sure you use this parametr, if your software depent on notes.


Response: Object with records (with location of GeoDNS A, AAAA, CNAME, SRV and NAPTR records) or failed status with status description. If a record has a note, the API method will return it.


Errors

When the authentication of the API user is not correct, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-password."}

In case the credentials of the API sub-user are invalid, the following status and statusDescription will be returned:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect sub-auth-id, sub-auth-user or auth-password."}

When an invalid or non-existent domain-name is entered, the following status will be returned:

{"status":"Failed","statusDescription":"Missing domain-name"}

If an invalid record type is entered for type parameter, it will be ignored and the result list will consist of all record types for a certain host.

Note: These are example errors in JSON format.


Example

URL JSON: https://api.cloudns.net/dns/records.json
Domain POST/GET:
auth-id=0&auth-password=password&domain-name=domain.com&host=hostname&type=a&rows-per-page=10&page=1
sub-auth-id=0&auth-password=password&domain-name=domain.com&host=hostname&type=a&rows-per-page=10&page=1
Reverse IPv4 POST/GET:
auth-id=0&auth-password=password&domain-name=1.0.0.127.in-addr.arpa&host=1&type=PTR&rows-per-page=10&page=1
sub-auth-id=0&auth-password=password&domain-name=1.0.0.127.in-addr.arpa&host=1&type=PTR&rows-per-page=10&page=1
Reverse IPv6 POST/GET:
auth-id=0&auth-password=password&domain-name=1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.ip6.arpa&host=@&type=PTR&rows-per-page=10&page=1
sub-auth-id=0&auth-password=password&domain-name=1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.ip6.arpa&host=@&type=PTR&rows-per-page=10&page=1

URL XML: https://api.cloudns.net/dns/records.xml
Domain POST/GET:
auth-id=0&auth-password=password&domain-name=domain.com&host=hostname&type=a&rows-per-page=10&page=1
sub-auth-id=0&auth-password=password&domain-name=domain.com&host=hostname&type=a&rows-per-page=10&page=1
Reverse IPv4 POST/GET:
auth-id=0&auth-password=password&domain-name=1.0.0.127.in-addr.arpa&host=1&type=PTR&rows-per-page=10&page=1
sub-auth-id=0&auth-password=password&domain-name=1.0.0.127.in-addr.arpa&host=1&type=PTR&rows-per-page=10&page=1
Reverse IPv6 POST/GET:
auth-id=0&auth-password=password&domain-name=1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.ip6.arpa&host=@&type=PTR&rows-per-page=10&page=1
sub-auth-id=0&auth-password=password&domain-name=1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.ip6.arpa&host=@&type=PTR&rows-per-page=10&page=1


Last modified: 2026-05-04
We value your privacy! We use cookies to enhance your browsing experience, and analyze our traffic. By clicking "Accept All", you consent to our use of cookies. Cookie Policy.