API

Softaculous API

Softaculous API can be used to perform various functions in Softaculous like Installing scripts, Upgrading installations, Importing installations, List Installations, Backup installations, Restore backups, List Backups, Remove installations, Delete backups, Download backups. 

Admin Functions

Authenticating

Each Control Panel has its own method of authentication. Some panels allow root/admin to access the enduser panel as the enduser over an API call. However that is beyond the scope of this guide.

Enduser

Authenticating

You need to write your authentication method in this step i.e. how the login in your control panel works. If your control panel requires cookie you can generate the cookie in this step and then pass on the cookie while making the API call.

Example

We will take an example of cPanel where the login details are passed in the URL.

$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?';

// Set the curl parameters
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

// Get response from the server.
$resp = curl_exec($ch);

Make sure you use this authentication while making any API call.

List Scripts

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actblank or anyAny act will do as this is available everywhere.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&act=home&api=serialize';

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);
 
// Get response from the server.
$resp = curl_exec($ch);

// Unserialize data
$res = unserialize($resp);

// The Installed scripts list is in the array key 'iscripts'
print_r($res['iscripts']);

Install a Script

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actsoftware, js, perlThe value should be “software” to install PHP script, “js” to install a JavaScript and “perl” to install a PERL script for softaculous to perform the action of installing a software.
soft26 (26 is the Script ID of WordPress)The value should be “SID” for softaculous to perform the action of installing a software. You can find the list of sid’s here
POST
softsubmit1This will trigger the install
softdomaindomain.comThis is the domain on which you wish to install the script
softdirectorywpThis is the sub-directory to install the script in. Leave it blank to install in root of the domain
softdbwp123This is the database name for the script. If the script does not require database you can leave this blank
dbusernamewp123This is the database user(Only for Softaculous Remote)
dbuserpassw1XRF28mq8This is the database password. You can generate a random password(Only for Softaculous Remote)
hostnamelocalhostThis is the hostname of your MySQL server. You can enter your MySQL server IP if you have MySQL on a remote server(Only for Softaculous Remote)
admin_usernameadminThis is the admin account username for the installation
admin_passpassThis is the admin account password for the installation
admin_emailadmin@domain.comThis is the admin account email address for the installation
languageenLanguage for the installation. You can get the language codes from the respective install.xml
site_nameMy BlogSite Name for the installation
site_descMy WordPress BlogSite Description for the installation
dbprefixdbpref_(Optional) Table Prefix to be used for the tables created by application
noemail1(Optional) – Use this only if you do not want to send an email to the user
overwrite_existing1(Optional) – Use this only if you do not want Softaculous to check for existing files in installation path. If any file(s) exists they will be overwritten.
softproto1 – http:// 
2 – http://www
3 – https:// 
4 – https://www.
(Optional) – Protocol to be used for the installation
eu_auto_upgrade1(Optional) – Pass 1 to enable auto upgrade. Auto upgrade will be enabled only if the script supports auto upgrade.
auto_upgrade_plugins1(Optional) – Pass 1 to enable auto upgrade plugins. If script supports auto upgrade for plugin then it will be enabled.
auto_upgrade_themes1(Optional) – Pass 1 to enable auto upgrade themes. If script supports auto upgrade for theme then it will be enabled.
auto_backupdaily – Once a day 
weekly – Once a week 
monthly – Once a month
(Optional) – Enable auto backups
auto_backup_rotation0 – Unlimited backup rotation
1 – backup rotation after 1 backup
4 – backup rotation after 1 backup
(Optional) – Possible values (0-10). Use this to set the value for auto backup rotation.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=software'.
                        '&soft=26';

$post = array('softsubmit' => '1',
              'softdomain' => 'example.com', // Must be a valid Domain
              'softdirectory' => 'wp', // Keep empty to install in Web Root
              'softdb' => 'wpdb',
              'admin_username' => 'admin',
              'admin_pass' => 'adminpassword',
              'admin_email' => 'admin@example.com',
              'language' => 'en',
              'site_name' => 'WordPress Site',
              'site_desc' => 'My Blog',
              'dbprefix' => 'dbpref_'
);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

Edit an Installation

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
acteditdetailThe value should be “editdetail” for softaculous to perform the action of editing an installation.
insid26_12345The installation ID that you want to edit. It can be fetched from List Installed Script
POST
editins1This will trigger the edit function
edit_dir/home/USERNAME/public_html(Optional) Path to installation. If not posted the path in existing records will be used.
edit_urlhttp://example.com(Optional) URL to installation. If not posted the URL in existing records will be used.
edit_datadir/home/USERNAME/datadir(Optional) Path to data directory of the installation. If not posted the data directory in existing records will be used.
edit_dbnameusername_dbname(Optional) Database name for the installation. If not posted the Database name in existing records will be used.
edit_dbuserusername_dbuser(Optional) Database user for the installation. If not posted the Database user in existing records will be used.
edit_dbpassdbpass(Optional) Password of the database user for the installation. If not posted the password in existing records will be used.
edit_dbhostlocalhost(Optional) Database host for the installation. If not posted the Database host in existing records will be used.
eu_auto_upgrade1(Optional) 1 to Enable auto upgrade for Major as well as for Minor update, and 2 to upgrade to only Minor version and 0 to disable. If not posted the existing setting will not be changed.
auto_upgrade_plugins1(Optional) 1 to Enable auto upgrade plugins option and 0 to disable. If not posted the existing setting will not be changed. (Currently this option is supported only in WordPress)
auto_upgrade_themes1(Optional) 1 to Enable auto upgrade themes option and 0 to disable. If not posted the existing setting will not be changed. (Currently this option is supported only in WordPress)
noemail1(Optional) – Use this only if you do not want to send an email to the user
admin_usernameadminusername(Optional) – Use this only if the script provides admin account creation at the time of installation
admin_passadminpassword(Optional) – Use this only if the script provides admin account creation at the time of installation

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=editdetail'.
                        '&insid=26_12345';

$post = array('editins' => '1',
              'edit_dir' => '/path/to/installation/', // Must be the path to installation
              'edit_url' => 'http://example.com', // Must be the URL to installation
              'edit_dbname' => 'wpdb',
              'edit_dbuser' => 'dbusername',
              'edit_dbpass' => 'dbuserpass',
              'edit_dbhost' => 'dbhost',
              'admin_username' => 'adminusername', //Provide this only if script provides as well as password needs to be reset
              'admin_pass' => 'adminpassword' //Provide this only if script provides
);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

// Print the entire output just incase !
print_r($res);

Upgrade an Installed Script

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actupgradeThe value should be “upgrade” for softaculous to perform the action of upgrading an installation.
insid26_12345The installation ID that you want to upgrade. It can be fetched from List Installed Script
POST
softsubmit1This will trigger the upgrade

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=upgrade'.
                        '&insid=26_12345';

$post = array('softsubmit' => '1');

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	// There might be some task that the user has to perform
	if(!empty($res['setupcontinue'])){

		echo 'Please visit the following URL to complete upgrade : '.$res['setupcontinue'];	

	// It upgraded
	}else{

		echo 'Upgraded successfully. URL to Installation : '.$res['__settings']['softurl'];	

	}

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

// Print the entire output just incase !
print_r($res);

Update Installation Version in Softaculous Records

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
acteditdetailThe value should be “editdetail” for softaculous to perform the action of editing an installation.
insid26_12345The installation ID that you want to edit. It can be fetched from List Installed Script
updateversion1The value should be 1 so it will invoke the method to determine and update the Softaculous records with the correct version of the installation

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=editdetail'.
                        '&insid=26_12345'.
                        '&updateversion=1';


// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

// Print the entire output just incase !
print_r($res);

Clone an Installed Script

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actscloneThe value should be “sclone” for softaculous to perform the action of cloning an installation.
insid26_12345The installation ID that you want to clone. It can be fetched from List Installed Script
POST
softsubmit1This will trigger the upgrade
softdomaindomain.comThis is the domain on which you wish to clone the installation
softdirectorywpThis is the sub-directory to clone the installation in. Leave it blank to clone in root of the domain
softdbwp123This is the database name for the cloned installation. If the script does not require database you can leave this blank.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=sclone'.
                        '&insid=26_12345';

$post = array('softsubmit' => '1',
              'softdomain' => 'example.com', // Must be a valid Domain
              'softdirectory' => 'wp', // Keep empty to install in Web Root
              'softdb' => 'wpdb'
);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	echo 'Cloned successfully. URL to Installation cloned installation : '.$res['__settings']['softurl'];

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

// Print the entire output just incase !
print_r($res);

Staging an Installed Script

KeyValueDescription
AuthentcationYou can use the Enduser Authenticating or Admin Authentication methods.
actstagingThe value should be “staging” for softaculous to perform the action of staging an installation.
insid26_12345Installation ID of the installation that you want to create staging copy for. It can be fetched from List Installed Script
POST
softsubmit1This will trigger the Staging
softdomaindomain.comThis is the domain on which you wish to create the staging
softdirectorywpThis is the sub-directory to create the staging. Leave it blank to create staging in root of the domain
softdbwp123This is the database name for the created staging installation. If the script does not require database you can leave this blank.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=staging'.
                        '&insid=26_12345';

$post = array('softsubmit' => '1',
              'softdomain' => 'domain.com', // Must be a valid Domain
              'softdirectory' => 'wp', // Keep empty to install in Web Root
              'softdb' => 'wpdb'
);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	echo 'Staging was successfully created. URL to Installation Staging installation : '.$res['__settings']['softurl'];

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

// Print the entire output just incase !
print_r($res);

Push To Live (Default Options)

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actpushtoliveThe value should be “pushtolive” for softaculous to perform the action of pushtolive the staging installation.
insid26_12345The installation ID that you want to pushtolive. It can be fetched from List Installed Script
POST
softsubmit1This will trigger the pushtolive function

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=pushtolive'.
                       '&insid=26_12345';

$post = array('softsubmit' => '1');

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	echo 'The Staging installation has been pushed successfully to live installation : '.$res['liveins']['softurl'];

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

// Print the entire output just incase !
print_r($res);

Push To Live (Customize Options)

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actpushtoliveThe value should be “pushtolive” for softaculous to perform the action of pushtolive the staging installation.
insid26_12345The installation ID that you want to pushtolive. It can be fetched from List Installed Script
POST
softsubmit1This will trigger the pushtolive
custom_push1This will trigger the advanced push where you can select to push files or database(full database and table structures or tables data)
overwrite_files1This will overwrite all the files of your live installation with the ones in Staging installation.
push_db1This will erase the live database and import the full database from your staging installation.
structural_change_tablesarray(‘wptd_posts’,’wptd_users’)(Optional) – This will be the array to push tables having structural changes.
datachange_tablesarray(‘wptd_posts’,’wptd_users’)(Optional) – This will be the array to push tables having data changes.
push_views1(Optional) – This will push all “views” from your staging installation to live site.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=pushtolive'.
                       '&insid=26_12345';

$post = array('softsubmit' => '1',
              'custom_push' => '1', 
              'overwrite_files' => '1', //This will push the files
              'push_db' => '1', //Push full database
              
);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	echo 'The Staging installation has been pushed successfully to live installation : '.$res['__settings']['softurl'];

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

// Print the entire output just incase !
print_r($res);

Remove an Installed Script

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actremoveThe value should be “remove” to perform the action of removing an installed script.
insid8 (Installation ID)Installation ID of the installed script. It can be fetched from List Installed Script
POST
removeins1This will trigger the remove install process
remove_dir1This is to remove the directory where the script is installed. If you do not want to remove the directory do not pass this key in post.
remove_datadir1This is to remove the data directory where the script is installed. If you do not want to remove the data directory do not pass this key in post.
remove_db1This is to remove the database of the installation. If you do not want to remove the database do not pass this key in post.
remove_dbuser1This is to remove the database user of the installation. If you do not want to remove the database user do not pass this key in post.
noemail1(Optional) – Use this only if you do not want to send an email to the user

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=remove'.
                        '&insid=8';

$post = array('removeins' => '1',
              'remove_dir' => '1', // Pass this if you want the directory to be removed
              'remove_datadir' => '1', // Pass this if you want the data directory to be removed
              'remove_db' => '1', // Pass this if you want the database to be removed
              'remove_dbuser' => '1' // Pass this if you want the database user to be removed
		);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

Import an Installation

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actimportThe value should be “import” to perform the action of importing an installation.
soft26 (26 is the Script ID of WordPress)The value should be “SID” for softaculous to perform the action of installing a software. You can find the list of sid’s here
POST
softdomainexample.comThis will be the domain where your script is installed. Domain should be without http:// or https://
softdirectorywp(OPTIONAL) This will be the directory under the domain where your script is installed. Leave this blank if the script is installed in the root of domain.
softsubmit1This will trigger the import function.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=import'.
			'&soft=26';

$post = array('softsubmit' => 1,
		'softdomain' => 'example.com',
		'softdirectory' => 'wp');

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

Import an Installation from Remote server

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actimportThe value should be “import” to perform the action of importing an installation.
soft26 (26 is the Script ID of WordPress)The value should be “SID” for softaculous to perform the action of installing a software. You can find the list of sid’s here
POST
domainsource.example.comThis will be the domain where your script is installed.
server_hostftp.example.com(OPTIONAL) This is the server host which will be used as the host to connect via FTP.
protocolftpThe Protocol to use for connecting to the domain. Currently only FTP protocol is supported.
port21Port number to connect to the FTP server. FTP default is 21.
ftp_userftp_userUser to connect to the FTP server.
ftp_passftp_passPassword for User to connect to the FTP server.
ftp_path/public_htmlPath to the directory relative to home directory of user for installations.
Installed_pathwp(OPTIONAL) This will be the directory under the domain where your script is installed. Leave this blank if the script is installed in the root of domain.
softdomaindestination.example.comThis is the destination domain on which you wish to import the script.
dest_directorywp_dest(OPTIONAL) This will be the directory under the domain where you want the installation to be imported. Leave this blank if you want to import the installation to the root of your domain.
softdbdbname(OPTIONAL) This is the database name for the script. If the script does not require database you can leave this blank
remote_submit1This will trigger the remote import function.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=import'.
			'&soft=26';

$post = array('remote_submit' => '1',
              'domain' => 'source.example.com', // Source installation domain
              'server_host' => 'ftp.example.com', // Optional
              'protocol' => 'ftp',
              'port' => '21',
              'ftp_user' => 'ftp_user',
              'ftp_pass' => 'ftp_pass',
              'ftp_path' => '/public_html',
              'Installed_path' => 'wp', // Optional
              'softdomain' => 'destination.example.com', // Destination domain
              'dest_directory' => 'wp_dest', // Optional Directory
              'softdb' => 'dbname' // Database name (Option for scripts that do not have database name)
);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

Get Script Info

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actsoftwareThe value should be “installations” to perform the action of listing installations.
soft26 (26 is the Script ID of WordPress)The value should be “SID” for softaculous to perform the action of installing a software. You can find the list of sid’s here
giveinfo1Pass this value as 1 to get the information of the script (passed in the soft parameter)

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=software'.
			'&soft=26'.
			'&giveinfo=1';


// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
print_r($res);
print_r($res['info']['overview']); // will have overview of the script (in HTML format)
print_r($res['info']['features']); // will have features list of the script (in HTML format)
print_r($res['info']['demo']); // will have the link to demo of the script
print_r($res['info']['ratings']); // will have the link to ratings page of the script
print_r($res['info']['support']); // will have the link to script vendor support page
print_r($res['info']['release_date']); // will have the release date of the current version of the script
print_r($res['settings']); // will have an array of the list of fields that the script will require, e.g. site_name, site_desc, language, etc
print_r($res['dbtype']); // if the value is not empty it means the script requires a database, if the value is empty it means that the script does not require a database
print_r($res['cron']); // if the value is not empty it means the script requires a CRON JOB, if the value is empty it means that the script does not require a CRON JOB
print_r($res['datadir']); // if the value is not empty it means the script requires a data directory, if the value is empty it means that the script does not require a data directory

List Installed Script

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actinstallationsThe value should be “installations” to perform the action of listing installations.
showupdatestrue(OPTIONAL) The value should be “true” if you want to list only installations that have an update available for softaculous to perform the action of listing installations.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=installations';


// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res['installations']);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

List Outdated Installations/ Installations that need update

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actinstallationsThe value should be “installations” to perform the action of listing installations.
showupdatestrueThe value should be “true” if you want to list only installations that have an update available for Softaculous to perform the action of listing installations.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=installations'.
			'&showupdates=true';


// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res['installations']);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

List Backups

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actbackupsThe value should be “backups” to perform the action of listing backups.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=backups';


// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res['backups']);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

Backup an Installed Script

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actbackupThe value should be “backup” to perform the action of taking the backup of the installation.
insid26_5454 (Installation ID)Installation ID of the installed script. It can be fetched from List Installed Script
POST
backupins1This will trigger the backup function.
backup_dir1This is to backup the directory
backup_datadir1This is to backup the data directory
backup_db1This is to backup the database
backup_location
(Location ID)
(Optional) – Location id of the backup location where you want to store your current backup. Default value will be the one saved in the installation’s settings. You can find the location id from List Backup Locations
noemail1(Optional) – Use this only if you do not want to send an email to the user

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=backup'.
			'&insid=26_4545';

$post = array('backupins' => '1',
              'backup_dir' => '1', // Pass this if you want to backup the directory
              'backup_datadir' => '1', // Pass this if you want to backup the data directory
              'backup_db' => '1', // Pass this if you want to backup the database
              'backup_location' => '2' //Pass this if you want the current backup to be stored at a different location.
		);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

Restore an Installed Script

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actrestoreThe value should be “restore” to perform the action of restoring the backup of the installation.
restorebackup_time_insid.tar.gz (Backup File Name)Name of the Backup File. It can be fetched from List Backups
POST
restore_ins1This will trigger the restore function.
restore_dir1This is to restore the directory
restore_datadir1This is to restorethe data directory
restore_db1This is to restore the database
noemail1(Optional) – Use this only if you do not want to send an email to the user

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=restore'.
			'&restore=backup_time_insid.tar.gz';

$post = array('restore_ins' => '1',
              'restore_dir' => '1', // Pass this if you want to restore the directory
              'restore_datadir' => '1', // Pass this if you want to restore the data directory
              'restore_db' => '1', // Pass this if you want to restore the database
		);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

Download Backups

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actbackupsThe value should be “backups” to perform the action of downloading the backup of an installation.
downloadbackup_time_insid.zip (Backup File Name)Name of the Backup File. It can be fetched from List Backups

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=backups'.
			'&download=backup_time_insid.zip';


// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

// This will have the backup file content
print_r($resp);

Delete Backups

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actbackupsThe value should be “backups” to perform the action of downloading the backup of an installation.
removebackup_time_insid.zip (Backup File Name)Name of the Backup File. It can be fetched from List Backups

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=backups'.
			'&remove=backup_time_insid.zip';


// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

Edit Enduser Settings

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actsettingsThe value should be “settings” to perform the action of updating the settings of a user.
POST
editsettings1This will trigger the edit settings function
languageenglishThe language you want to set for the user.
timezone0This is the timezone that you want to set for the user. User 0 to set the timezone to Server Default.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=settings';

$post = array('editsettings' => 1,
		'language' => 'english',
		'timezone' => '0');

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

Edit Enduser Email Settings

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actemailThe value should be “email” to perform the action of updating the email settings of a user.
POST
editemailsettings1This will trigger the edit email settings function
emailadmin@example.com(Optional) Pass a valid email to receive the updates, leave blank to leave the email unchanged.
ins_email1(Optional) Pass this as 1 to enable receiving email for new installations, off to disable the same.
rem_email1(Optional) Pass this as 1 to enable receiving email after removing an installation, off to disable the same.
editdetail_email1(Optional) Pass this as 1 to enable receiving email after editing an installation, off to disable the same.
backup_email1(Optional) Pass this as 1 to enable receiving email after backup of an installation, off to disable the same.
restore_email1(Optional) Pass this as 1 to enable receiving email after restore of an installation, off to disable the same.
clone_email1(Optional) Pass this as 1 to enable receiving email after cloning an installation, off to disable the same.
disable_all_notify_update1(Optional) Pass this as 1 to disable receiving update available notification email, off to enable the same.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=email';

$post = array('editemailsettings' => 1,
		'email' => 'admin@example.com',
		'ins_email' => '1');

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

Auto Sign On

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actsign_onThe value should be “sign_on” to perform the action to get the sign on URL.
insid26_12345The installation ID that you want to edit. It can be fetched from List Installed Script
autoidabcdefghijklmnopqrstuvwxyz0123456789This must be any 32 character random string.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=sign_on'.
			'&insid=26_12345'.
			'&autoid=abcdefghijklmnopqrstuvwxyz0123456789';


// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);
 
// Get response from the server.
$resp = curl_exec($ch);

On using this API, you will get the sign_on_url, upon accessing which the user will be logged in to the admin panel of the script. You can use the same URL to redirect the user as shown here:

$op = unserialize($resp);
header('Location: '.$op['sign_on_url']);

Task list Status

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating methods.
acteu_tasklistThe value should be “eu_tasklist” to perform the action to get the status of the task.
sskabcdefghijklmnopqrstuvwxyz0123456789The ssk is the status file.

Example

// The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
			'&api=serialize'.
			'&act=eu_tasklist'.
			'&ssk=abcdefghijklmnopqrstuvwxyz0123456789';


// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);
 
// Get response from the server.
$resp = curl_exec($ch);

You will get the response as follows:

Array (     
[title] => Softaculous - Task List
[status] => Array
(
[process] =>
[current_status] => Propagating the database
[sid] => 26
[name] => WordPress
[version] => 4.7.5
[softurl] => https://domain.com/
[completed] => Installation Completed
[progress] => 100
)
[no_tasks] =>
[tasks_file] =>
[timenow] => 1496828740
[time_taken] => 0.001
)

Add Remote Backup Location

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating methods.
actaddbackuplocThe value should be “addbackuploc” to perform the action to add the remote backup location.
POST
addbackuploc1This will trigger the backup location addition process.
location_nameBackuploc1A reference name for the Backup Location.
server_hostexample.comServer Host where you want to store your backups.
protocolftpProtocol with which you want to connect to the server host. If empty, default protocol will be FTP.
port21Port with which you want to connect to server host. If empty, default FTP port will be 21.
ftp_userftpusernameUsername of the FTP account.
ftp_passftppasswordPassword of the FTP account.
backup_loc/backupsRelative path from FTP user’s directory where you want to store your backups.

Example

//The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
	      '&api=serialize'.
	      '&act=addbackuploc';
			
$post = array('addbackuploc' => '1',
              'location_name' => 'Backuploc1',
              'server_host' => 'example.com', // Pass the server host where you want to store the backup			  
              'protocol' => 'ftp', // Pass the protocol with which you want to connect to server host. Default is FTP.
	      'port' => '21', // Pass the port to connect with server host. Default FTP port is 21.
	      'ftp_user' => 'ftpusername',
	      'ftp_pass' => 'ftppassword',
	      'backup_loc' => '/backups',
	      );

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);

// Done ?
if(!empty($res['done'])){

	echo "Backup location added to server";

// Error
}else{

	echo 'Some error occurred';
	print_r($res['error']);

}

List Backup Locations

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating methods.
actsettingsThe value should be “settings” to perform the action to list the backup locations added by you.

Note: This API will be available from Softaculous 4.9.4.

Example

//The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
	    '&api=serialize'.
	    '&act=settings';
			
// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);

//Display the list of backup locations
print_r($res['backup_locs']);

Edit a Remote Backup Location

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating methods.
acteditbackuplocThe value should be “editbackuploc” to perform the action to edit a particular remote backup location.
loc_id1Location ID of a remote backup location. It can be fetched from List Backup Locations.
POST
editbackuploc1This will trigger the backup location edit process.
location_nameBackuploc1A reference name for the Backup Location.
server_hostexample.comServer Host where you want to store your backups.
protocolftpProtocol with which you want to connect to the server host. If empty, default protocol will be FTP.
port21Port with which you want to connect to server host. If empty, default FTP port will be 21.
ftp_userftpusernameUsername of the FTP account.
ftp_passftppasswordPassword of the FTP account.
backup_loc/backups1Relative path from FTP user’s directory where you want to store your backups.

Example

//The URL
$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
	      '&api=serialize'.
	      '&act=editbackuploc'.
	      '&loc_id=1';
			
$post = array('editbackuploc' => '1',
              'location_name' => 'Backuploc1',
              'server_host' => 'example.com', // Pass the server host where you want to store the backups			  
              'protocol' => 'ftp', // Pass the protocol with which you want to connect to server host. Default is FTP.
	      'port' => '21', // Pass the port with which you want to connect to FTP user account. Default FTP port is 21.
	      'ftp_user' => 'ftpusername',
	      'ftp_pass' => 'ftppassword',
	      'backup_loc' => '/backups1'
	      );

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);

// Done ?
if(!empty($res['done'])){

	echo "Backup location editted successfully";

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

Delete a Remote Backup Location

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating methods.
actsettingsThe value should be “settings” to perform the action to delete a particular remote backup location from list.
del_loc_id1Location ID of a remote backup location. It can be fetched from List Backup Locations.

Example

$url = 'https://user:password@domain.com:2083/frontend/paper_lantern/softaculous/index.live.php?'.
	     '&api=serialize'.
	     '&act=settings'.
	     '&del_loc_id=1';

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);

// The response will hold a string as per the API response method. In this case its PHP Serialize.
$res = unserialize($resp);

//Display list of backup locations after successfully removal of a backup location.
print_r($res['backup_locs']);

Admin Panel API

List Installations (Admin Panel)

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actinstallationsThis will trigger the list installations function.
POST
listinstallations1This will trigger the listinstallations function
usersroot;user1;(Optional) Pass ; separated list of users to filter installations by users
scriptsWordPress;Joomla;(Optional) Pass ; separated list of scripts to filter installations by scripts

Example

// URL
$url = 'http://admin.controlpanel.com:PORT/url/to/softaculous/index.php?'.
			'&api=serialize'.
			'&act=installations';

$post = array('listinstallations' => 1,
              //'users' => 'root;user1;', // Pass this if you want the installation list of specific users
              //'scripts' => 'WordPress;Joomla;', // Pass this if you want the installation list of specific scripts
              );

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res)){

	print_r($res);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

List Outdated Installations (Admin Panel)

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actinstallationsThis will trigger the list installations function.
showoutdatedThis will trigger the outdated installations list function
POST
listinstallations1This will trigger the listinstallations function
usersroot;user1;(Optional) Pass ; separated list of users to filter installations by users
scriptsWordPress;Joomla;(Optional) Pass ; separated list of scripts to filter installations by scripts

Example

// URL
$url = 'http://admin.controlpanel.com:PORT/url/to/softaculous/index.php?'.
			'&api=serialize'.
			'&act=installations'.
			'&show=outdated';

$post = array('listinstallations' => 1,
              //'users' => 'root;user1;', // Pass this if you want the installation list of specific users
              //'scripts' => 'WordPress;Joomla;', // Pass this if you want the installation list of specific scripts
              );

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res)){

	print_r($res);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

List Real Version (Admin Panel)

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actinstallationsThis will trigger the list installations function.
POST
listinstallations1This will trigger the listinstallations function
only_realversion1This will trigger the only_realversion function to list only installations in which the version in Softaculous records do not match with actual installation version

Example

// URL
$url = 'http://admin.controlpanel.com:PORT/url/to/softaculous/index.php?'.
			'&api=serialize'.
			'&act=installations';

$post = array('listinstallations' => 1, 'only_realversion' => 1);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res)){

	print_r($res);

}

Update Real Version (Admin Panel)

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actinstallationsThis will trigger the list installations function.
POST
listinstallations1This will trigger the listinstallations function
only_realversion1This will trigger the only_realversion function to list only installations in which the version in Softaculous records do not match with actual installation version
listarray(‘username-26_68351’, ‘username-26_68352’)This will contain the array list for the installations which needs to be updated in Softaculous record(you will need to pass installation id which you will get from Real Version response in List Real Version

Example

// URL
$url = 'http://admin.controlpanel.com:PORT/url/to/softaculous/index.php?'.
			'&api=serialize'.
			'&act=installations';

$post = array('listinstallations' => 1, 'only_realversion' => 1, 'list' => array('username-26_68351', 'username-26_68352'));

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res)){

	print_r($res);

}

Installation Statistics (Admin Panel)

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actins_statisticsThis will trigger the installation statistics function

Example

// URL
$url = 'http://admin.controlpanel.com:PORT/url/to/softaculous/index.php?'.
			'&api=serialize'.
			'&act=ins_statistics';

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

Add Plan (ACL)

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actaddplansThis will trigger the add plan function
POST
saveplan1This will trigger the add plan function
plannameplan1Plan name for the new plan being created
resellers_abc1(Optional) Use this only if you want to add a reseller to the plan. resellers_ is the prefix for adding a reseller and abc is the name of the reseller (that should already exist). Similarly pass a separate key for each reseller you want to add to the plan.
users_xyz1(Optional) Use this only if you want to add a user to the plan. users_ is the prefix for adding a user and xyz is the name of the user (that should already exist). Similarly pass a separate key for each user you want to add to the plan.
scripts_261Use this to pass the scripts to be added to the plan. scripts_ is the prefix for adding a script and 26 is the id of the script to be added. Similarly pass a separate key for each script you want to add to the plan. Get Script ids

Example

// URL
$url = 'http://admin.controlpanel.com:PORT/url/to/softaculous/index.php?'.
			'&api=serialize'.
			'&act=addplans';

$post = array('saveplan' => '1',
	'planname' => 'plan1',
	'resellers_abc' => '1',
	'users_xyz' => '1',
	'scripts_26' => '1', // Add WordPress
	'scripts_413' => '1' // Add Joomla
);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

Edit Plan (ACL)

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
acteditplansThis will trigger the edit plan function
planplan1This will be the plan name of the plan you want to edit
POST
saveplan1This will trigger the add plan function
plannameplan1Plan name for the new plan being created
resellers_abc1(Optional) Use this only if you want to assign a reseller to the plan. resellers_ is the prefix for adding a reseller and abc is the name of the reseller (that should already exist). Similarly pass a separate key for each reseller you want to assign to the plan.
users_xyz1(Optional) Use this only if you want to assign a user to the plan. users_ is the prefix for assigning a user and xyz is the name of the user (that should already exist). Similarly pass a separate key for each user you want to assign to the plan.
scripts_4131Use this to pass the scripts to be assigned to the plan. scripts_ is the prefix for assigning a script and 26 is the id of the script to be assigned. Similarly pass a separate key for each script you want to assign to the plan. Get Script ids

Example

// URL
$url = 'http://admin.controlpanel.com:PORT/url/to/softaculous/index.php?'.
			'&api=serialize'.
			'&act=editplans'.
			'&plan=plan1';


$post = array('saveplan' => '1',
	'planname' => 'plan1',
	'resellers_abc' => '1',
	'users_xyz' => '1',
	'scripts_543' => '1', // Add Drupal
	'scripts_72' => '1' // Add PrestaShop
);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

Delete Plan (ACL)

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actplansThis is the default plans page act
deleteplan1This will be the plan name of the plan you want to delete

Example

// URL
$url = 'http://admin.controlpanel.com:PORT/url/to/softaculous/index.php?'.
			'&api=serialize'.
			'&act=editplans'.
			'&act=plans'.
			'&delete=plan1';

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}

Enable / Disable Script

KeyValueDescription
AuthenticationYou can use the Enduser Authenticating or Admin Authentication methods.
actsoftwaresThis will trigger the enable/disable script function
POST
updatesoftUpdate SettingsThis will trigger the submit function for enabling/disabling the scripts
soft_261Use it to Enable Script from Admin Panel. soft_ is the prefix for enabling a script and 26 is the id of the script to be enabled. Similarly pass a separate key for each script you want to enable. Get Script ids

Note: If you have 10 scripts Enabled. You want to Enable 1 more script you will need to pass all 11 scripts id in the POST data for it to Enable the script. The scripts which are not posted will be disabled.

Example

// URL
$url = 'http://admin.controlpanel.com:PORT/url/to/softaculous/index.php?'.
			'&api=serialize'.
			'&act=softwares';

$post = array('updatesoft' => 'Update Settings',
	'soft_26' => 1, // WordPress
	'soft_18' => 1, // Joomla 2.5
	'soft_543' => 1, // Drupal 8
	'soft_11' => 1, // Open Blog
	'soft_3' => 1, // Serendipity
	'soft_34' => 1, // Dotclear
	'soft_14' => 1, // b2evolution
	'soft_470' => 1 // Ghost
);

// Set the curl parameters.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $time);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Turn off the server and peer verification (TrustManager Concept).
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}
 
// Get response from the server.
$resp = curl_exec($ch);
 
// The response will hold a string as per the API response method. In this case its PHP Serialize
$res = unserialize($resp);
 
// Done ?
if(!empty($res['done'])){

	print_r($res);

// Error
}else{

	echo 'Some error occured';
	print_r($res['error']);

}
Was this helpful to you?