List sub users

Description

Gets a list of the sub users you have. The method works with pagination.


 Parameters

Name Data Type Status Description
auth-id Integer Required Authentication parameter
auth-password String Required Authentication parameter
page Integer Required Current page your sub users list is on
rows-per-page Integer Required Results per page. Can be 10, 20, 30, 50 or 100.

Return: Array with the found sub users.


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."}

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

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

If there is not added a value for "rows-per-page", the following status will be returned:

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

Note: These are example errors in JSON format, and these are not the only errors that can be displayed.


Example

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

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


Last modified: 2020-01-13
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more