Skip to content
cPanel API 2 Modules
/
cPanel API 2 Modules - LangMods
/
cPanel API 2 Functions - LangMods::list_installed
Last updated

cPanel API 2 Functions - LangMods::list_installed

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function lists a cPanel-supported scripting language's installed modules.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=LangMods&cpanel_jsonapi_func=list_installed&lang=php-pear&sys=1
Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve installed php-pear modules on example.com.
my $get_installed_modules = $cpliveapi->api2(
    'LangMods', 'list_installed',
        array(
        'lang'          => 'php-pear',
        'sys'           => '1',
     )
  );
Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve installed php-pear modules on example.com.
$get_installed_modules = $cpanel->api2(
    'LangMods', 'list_installed',
    {
        'lang'      => 'php-pear',
        'sys'       => '1',
     }
 );
Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:
  • cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

syntaxhighlighter-pre
cpapi2 --user=username LangMods list_installed lang=php-pear sys=1
Notes:

  • You must URI-encode values.

  • username represents your account-level username.

  • You must include the --user=username option.

  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.

  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    syntaxhighlighter-pre
    /usr/local/cpanel/bin/cpapi2

Output (JSON)

syntaxhighlighter-pre
{  
   "cpanelresult":{  
      "apiversion":2,
      "func":"list_installed",
      "data":[  
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/Archive_Tar/docs",
            "latest":"1.3.11",
            "installed":null,
            "module":"Archive_Tar",
            "stable":"1.3.11"
         },
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/Console_Getopt/docs",
            "latest":"1.3.1",
            "installed":null,
            "module":"Console_Getopt",
            "stable":"1.3.1"
         },
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/PEAR/docs",
            "latest":"1.9.5",
            "installed":null,
            "module":"PEAR",
            "stable":"1.9.5"
         },
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/Structures_Graph/docs",
            "latest":"1.0.4",
            "installed":null,
            "module":"Structures_Graph",
            "stable":"1.0.4"
         },
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/XML_RPC/docs",
            "latest":"1.5.5",
            "installed":null,
            "module":"XML_RPC",
            "stable":"1.5.5"
         },
         {  
            "info":"stable",
            "docurl":"http://pear.php.net/package/XML_Util/docs",
            "latest":"1.2.3",
            "installed":null,
            "module":"XML_Util",
            "stable":"1.2.3"
         }
      ],
      "event":{  
         "result":1
      },
      "module":"LangMods"
   }
}
Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
langstring

Required

The scripting language's short name.

An available scripting language's short name.

The LangMods::langlist function returns possible values.

perl
sysBoolean

Required

Whether to return the account's installed modules.

  • 1 — Return the account's installed modules.
  • 0 — Return the system's installed modules.
1

Returns

ReturnTypeDescriptionPossible valuesExample
infostringAny relevant information.A string value.Stable
docurlstringThe system's homepage.A URL.http://pear.php.net/package/Config/docs
lateststringThe module's latest version.A module version.1.2.3
installedstringThe module's installed version.
  • A version of the module.
  • null — The module is not installed.
1.2.3
modulestringThe module's name.A module name.XML_Util
stableboolean

The module's stable version.

A module version.1.2.3
reasonstring

A reason for failure.

This function only returns a reason value if there was an error.

A string that describes the error.This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1
Previous page
Next page