List registered domains

Description

Gets a list with registered domains. The method can be combined with search option. If you use optional search parameter, you will get the number of pages with registered domains that match the search.


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
rows-per-page Integer Required Results per page. Can be 10, 20, 30, 50 or 100
page Integer Required Current page your domains list is on
search String Optional Domain name, reverse zone name or keyword to search in the zone names for
order_by String Optional

The default value is name. Possible values:

  • name
  • expire
  • registered

Return: List of the registered domains of the user.


Errors

When the authentication of 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 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."}

If there is not added a parameter "rows-per-page" or if the added value for "rows-per-page" is invalid (Can be 10, 20, 30, 50 or 100), the following status will be returned:

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

If there is not added a parameter "page", the following status will be returned:

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

Note: These are example errors in JSON format.


Example

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

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


Last modified: 2023-07-11
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more