Get pages count

Description

Gets the number of pages with zones. The method can be combined with search option. If you use optional search parameter, you will get the number of pages with zones that match the search. 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
rows-per-page Integer Required Results per page. Can be 10, 20, 30, 50, 100 or 250
search String Optional Domain name, reverse zone name or keyword to search in the zone names for
group-id Integer Optional ID of the relevant group. If group's ID is set up, the pages for all zones in this group will be counted. If value none is set up for parameter group-id, the pages for all not included zones in this group will be counted.
has-cloud-domains Integer Optional Possible value: 1. Show page count only for zones that have cloud domains.

Return: The number of the pages with zones.


Errors

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

When rows-per-page paremeter is not from the suggested values (10, 20, 30, 50, 100 or 250) or 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/get-pages-count.json
POST/GET: auth-id=0&auth-password=password&rows-per-page=10
POST/GET: sub-auth-id=0&auth-password=password&rows-per-page=10

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


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