Add new sub user

Description

Adds a new api sub user


 Parameters

Name Data Type Status Description
auth-id Integer Required Authentication parameter
auth-password String Required Authentication parameter
password String Required Password of the new sub user
sub-auth-user String Optional Username for the new sub user
zones Integer Required Amount of allowed DNS zones
mail-forwards Integer Required Amount of allowed mail forwards
ip Integer Optional Whitelisted IP address. If no IP address is provided the access from all IPs will be allowed.
failover-checks Integer Optional Amount of allowed failover checks. Default value is 0.
records Integer Optional Amount of allowed records.
write Integer Optional Access level of the sub-user. Default value is Read and Write. Possible values:
  • 0 - Read
  • 1 - Read and Write

Return: Array with status and status description and user's id.


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 zone limit or the zone field value is not numeric, the following status will be returned:

{"status":0,"message":"The zones field values must be numeric"}

If there is not added a mail forward limit or the mail forward field value is not numeric, the following status will be returned:

{{"status":0,"message":"The mail forward field value must be numeric"}

When the added IP address is not valid, the following status will be returned:

{"status":0,"message":"Invalid IP address."}

Note: These are example errors in JSON format


 Example

URL JSON: https://api.cloudns.net/sub-users/add.json
POST/GET: auth-id=0&auth-password=password&sub-auth-user=user&password=password&zones=12&mail-forwards=13&ip=1.2.3.5&records=200

URL XML: https://api.cloudns.net/sub-users/add.xml
POST/GET: auth-id=0&auth-password=password&sub-auth-user=user&password=password&zones=12&mail-forwards=13&ip=1.2.3.5&records=200


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