Installatron Server
API Documentation
Login User
POST
/users/{id}/login
Create a user/reseller/admin session for the Installatron Server GUI.
Note: this API was previously named guixfer. That name will continue to work.
Parameters
API
/users/{id}/login
API endpoint.
{id} is the username of the user to create a GUI session for.
{id} is the username of the user to create a GUI session for.
POST
Method.
Optional parameters
language
enum
The language to use for this login session to the application. For example,
Use the /api/is/browser/view to retrieve a list of available languages for the application.
default is the the language configured for the user
en
for English or zh_tw
for Chinese Traditional.Use the /api/is/browser/view to retrieve a list of available languages for the application.
default is the the language configured for the user
Response
Response
status
int
HTTP status code describing the result of the request.
All other numbers represent errors which are described in the errcode output below.
200
for Success.All other numbers represent errors which are described in the errcode output below.
session_id
string
Session ID created for this login.
(eg.
(eg.
RMXIft8-8HExkSXbTooEvg
)result
boolean
true
= Success.false
= Failure.errcode
string
status code 403
invalid_api_key
The server's Installatron Server Key is invalid.
invalid_argument_user
User specified is not authorized to access this data.
status code 404
user_not_found
The specified user could not be found in the Installatron Server database.
message
string
Message describing the result of the request. Do not rely on this to determine the success or failure of the request.
data
string
URI to access Installatron's GUI, in the general form of
https://ip-74-208-16-176.is.direct/RMXIft8-8HExkSXbTooEvg
.Full Examples
Example: Create a session for Installatron Server's GUI for a user owned by the main administrator
Method: curl
Installatron Product: Installatron Server
curl -X POST https://{SERVER_IP}/users/useraccountname/login \
-H 'X-API-KEY: {the key= or key2= value from /usr/local/installatron/etc/settings.ini}' \
-H 'Accept: application/json'Response: json
{
"result": true,
"status": 200,
"errcode": null,
"errfield": null,
"message": "The task is complete.\n"
"data": "https://ip-123-123-123-123.is.direct/RMXIft8-8HExkSXbTooEvg"
}
Since 2004, Installatron has pioneered web application management solutions trusted by businesses and website owners worldwide.
Resources
Developers