Skip to content

Client Key Login

Supported Versions Last Updated
1.15.00 & higher
json output 1.15.00 & higher
2014/03/09
Action client-key-login
Method GET, POST
Variables

vserverid [vserverid of client] Optional if username is specified

username [username of the client] Optional if vserverid is specified

returnurl [url to return the client to on logout] Optional

forward [forward to virtual server manage page if vserverid is specified] 0|1 Optional

rdtype [json] For json output specify json or for default output leave blank. This variable is optional

Example Output

XML

Success:

 <status>success</status>

<hasha>22bf0d328a3b62320ad1852e894005fd9292182d8b7336910</hasha>

<hashb>fbc5880f2a7411f0cc1ee63864c2e9700c9a6220e8</hashb>

<statusmsg></statusmsg>

Error:

 <status>error</status>

<statusmsg>invalid username</statusmsg>

JSON

Success:

 {"status":"success",

"hasha":"22bf0d328a3b62320ad1852e894005fd9292182d8b7336910",

"hashb":"fbc5880f2a7411f0cc1ee63864c2e9700c9a6220e8",

"statusmsg":""}

Error:

{"status":"error","statusmsg":"invalid username"}