Login API method

Description

Test login details.


 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

Return: Array with status and status description.


 Example

URL JSON: https://api.cloudns.net/dns/login.json
POST/GET: auth-id=0&auth-password=password

URL XML: https://api.cloudns.net/dns/login.xml
POST/GET: auth-id=0&auth-password=password

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

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

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