Add new sub-user

Description

Add 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. It should be min. 6 characters
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. The default option is: Access from all IPs will be allowed
failover-checks Integer Optional Amount of allowed failover checks. The default value is 0
monitoring-checks Integer Optional Amount of allowed monitoring checks. The default value is 0
records Integer Optional Amount of allowed records
write Integer Optional Access level of the sub-user. The default value is Read and Write. Possible values:
  • 0 - Read
  • 1 - Read and Write

Return: Confirmation that the sub-user is added and his ID


Possible errors (example)

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

{"status":"Failed","statusDescription": "Invalid authentication, incorrect user ID or password."}

If a zone limit is not added or the value is not numeric, the following status will be returned:

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

If a mail forward limit is not added or the 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 correct, 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: 2025-05-15
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more