Description
This function lists an account's available cPAddons.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/cPAddons/get_available_addons
LiveAPI PHP Class
$cpanel = new CPANEL();
$app_info = $cpanel->uapi(
'cPAddons', 'get_available_addons'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $app_info = $cpliveapi->uapi(
'cPAddons', 'get_available_addons',
);
cPanel Template Toolkit
[% data = execute( 'cPAddons', 'get_available_addons' ); %]
Command Line
uapi --user=username cPAddons get_available_addons
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"metadata": {
"transformed": 1
},
"data": [
{
"description": "WordPress (cPanel)",
"module": "cPanel::Blogs::WordPress"
},
{
"description": "Mambo (cPanel)",
"module": "cPanel::CMS::Mambo"
},
{
"description": "cPSupport (cPanel)",
"module": "cPanel::Support::cPSupport"
}
]
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
description
|
string
|
The cPAddon's name.
|
A valid cPAddon.
|
WordPress
|
|
module
|
string
|
The module's name.
|
A valid string.
|
cPanel::Blogs::WordPress
|
