cPanel API 2 Functions - LangMods::list_installed - Knowledgebase

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)

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

 LiveAPI PHP Class

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',
     )
  );

 LiveAPI Perl Module

$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',
     }
 );

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{ 
   "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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
lang	string	Required The scripting language's short name.	An available scripting language's short name. Note: The LangMods::langlist function returns possible values.	perl
sys	boolean	Required Whether to return the account's installed modules.	1 — Return the account's installed modules. 0 — Return the system's installed modules.	1

Parameter

Type

Description

Possible values

Example

lang

string

Required

The scripting language's short name.

An available scripting language's short name.

Note:

The LangMods::langlist function returns possible values.

perl

sys

boolean

Required

Whether to return the account's installed modules.

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

Returns

Return	Type	Description	Possible values	Example
info	string	Any relevant information.	A string value.	Stable
docurl	string	The system's homepage.	A URL.	http://pear.php.net/package/Config/docs
latest	string	The module's latest version.	A module version.	1.2.3
installed	string	The module's installed version.	A version of the module. null if not installed.	1.2.3
module	string	The module's name.	A module name.	XML_Util
stable	boolean	The module's stable version.	A module version.	1.2.3
reason	string	A reason for failure. Note: This function only returns a reasonvalue if there was an error.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories