Admin HTTP API

From Softaculous Wiki
Jump to: navigation, search

Overview

This page will guide you how to use the Softaculous Admin HTTP API


Available Output

The default output will be a serialized PHP array. JSON and XML are also available. You can specify the method in the URL query. e.g. to get in JSON

/url/to/softaculous/index.php?api=json&act=listinstallations


List of Installations

To get a list of the installations made by users

/url/to/softaculous/index.php?api=serialize&act=installations&listinstallations=1


Arguments

The following arguments can be passed via GET or POST

  • users - Semi Colon seperated list of users. If empty all users will be assumed.
  • scripts - Semi Colon seperated list of SCRIPTS. If empty all scripts will be assumed.
  • only_outdated - Boolean value must be given IF only outdated installs are to be listed. Default is OFF
  • group_by_scripts - Default results are grouped by users. If a boolean value is given then it will group by scripts


Example

The following is an example for cPanel

include('/path/to/softaculous/api/api.php');
whmquery('KEY', 'https://IP:2087/cgi/softaculous/index.php?api=serialize&act=installations&listinstallations=1');

NOTE : whmquery is a function defined in /path/to/softaculous/api/api.php