Self Help Documentation
< All Topics

software/installjoomla

Posted
Updated

Description

Installs Joomla for an existing domain from a given SPanel user account.

Warning
The Joomla administrator password must not contain ‘ (single quote) or ; (semicolon).

Parameters

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.
domainstringYesThe domain to install Joomla on. Must already exist in the account.
folderstringNoInstallation folder under the selected domain’s document root (for example: joomla). Use empty value to install in the main folder.
usernamestringYesJoomla administrator username.
passwordstringYesJoomla administrator password.
emailstringYesJoomla administrator email address.

Example

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'software/installjoomla',
  'domain' => 'example.com',
  'folder' => 'joomla',
  'username' => 'joomlaadmin',
  'password' => 'StrongPassword_123!',
  'email' => '[email protected]',
];
 
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );

You can find more information about the Endpoint URL in our API Basics article.

Output

PHP
1
2
3
4
5
6
{
    "result": "success",
    "data": {
        "msg": "Your Joomla was installed successfully."
    }
}
Table of Contents