Installatron Server
API Documentation
Login Into Install
POST
/installs/{id}/login
Log into an installed application's administrative backend (aka. "SSO" or "Single Sign-On").
This feature is currently only available for installs of WordPress, Joomla!, ClassicPress, and Modx.
Parameters
API
/installs/{id}/login
API endpoint.
{id} is the internal ID of the install to log into as administrator.
{id} is the internal ID of the install to log into as administrator.
POST
Method.
Optional parameters
url
string
Optional URL the user will be forwarded to after a successful login. This can be a relative to the application's URL or a full URL.
default is to automatically forward to the application's administrative backend
default is to automatically forward to the application's administrative backend
user
string
The Installatron Server user the task is to be performed on or for.
default is the owner of the installation identified by {id} in the API request
default is the owner of the installation identified by {id} in the API request
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.
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
install_not_found
The app ID was not found or it was found by is owned by a user who does not have access to it.
status code 500
failed_website_vhost
User's webhosting account does not manage this domain. That is, the domain is in the account's vhosts list.
failed_filesystem_host
Unable to reach the remote host.
failed_filesystem_login
The SFTP/FTP/SFTP server rejected the login.
failed_filesystem_ondemand
(Only when when enablePath is defined in /usr/local/instalatron/etc/panel.php) The path was invalid.
failed_filesystem_permission
Insufficient user permissions to the path provided.
failed_filesystem_quota
User's Disk Space or Files Usage (inodes) quota was exceeded.
errfield
enum
If the cause of an error was an incorrect field value then this will show the ID of the field.
(eg.
(eg.
login
, passwd
, email
)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
URL to the single-sign-on script that was created. Forward the user's browser to this URL to log into the application.
(eg.
(eg.
https://website.com/blog/deleteme.sso12345.php?12345
)Full Examples
Example: Login to a WordPress backend and view its administrative page
Method: curl
Installatron Product: Installatron Server (switch to Installatron Plugin)
curl -X POST https://{SERVER_IP}/installs/1234567890abcdefghij12345/login \
-H 'X-API-KEY: {the key= or key2= value from /usr/local/installatron/etc/settings.ini}' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '
{
"url": "https://www.website.com/wp-admin"
}
'
Response: json
{
"status": 200,
"result": true,
"message": "The task is complete.\n",
"data": "https://website.com/blog/deleteme.sso1234567890abcdefghij1234567890ab.php?1234567890abcdefghij1234567890abc"
}Example: Login to a WordPress backend and view its administrative page using a relative URL
Method: curl
Installatron Product: Installatron Server (switch to Installatron Plugin)
curl -X POST https://{SERVER_IP}/installs/1234567890abcdefghij12345/login \
-H 'X-API-KEY: {the key= or key2= value from /usr/local/installatron/etc/settings.ini}' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '
{
"url": "/wp-admin"
}
'
Response: json
{
"status": 200,
"result": true,
"message": "The task is complete.\n",
"data": "https://website.com/blog/deleteme.sso1234567890abcdefghij1234567890ab.php?1234567890abcdefghij1234567890abc"
}Example: Login to a ModX backend and view its administrative page using a different type of relative URL
Method: curl
Installatron Product: Installatron Server (switch to Installatron Plugin)
curl -X POST https://{SERVER_IP}/installs/1234567890abcdefghij12345/login \
-H 'X-API-KEY: {the key= or key2= value from /usr/local/installatron/etc/settings.ini}' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '
{
"url": "controllers/default/welcome.class.php"
}
'
Response: json
{
"status": 200,
"result": true,
"message": "The task is complete.\n",
"data": "https://website.com/blog/deleteme.sso1234567890abcdefghij1234567890ab.php?1234567890abcdefghij1234567890abc"
}
Since 2004, Installatron has pioneered web application management solutions trusted by businesses and website owners worldwide.
Resources
Developers