cPanel API 2 Functions - LangMods::search - Knowledgebase

Description

This function lists a cPanel-supported scripting language's available 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=search&lang=php-pear&skip=3&want=6&regex=Lite

 LiveAPI PHP Class

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Search for Lite in language modules
my $get_phppear_modules = $cpliveapi->api2(
    'LangMods', 'search',
        array(
        'lang'          => 'php-pear',
        'skip'          => '3',
        'want'          => '6',
        'regex'         => 'Lite',
      )
  );

 LiveAPI Perl Module

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Search for Lite in language modules.
$search_lang_modules = $cpanel->api2(
    'LangMods', 'search',
    {
        'lang'      => 'perl',
        'skip'      => '3',
        'want'      => '6',
       'regex'     => 'Lite',
    }
 );

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.

Command Line

cpapi2 --user=username LangMods search lang=perl skip=3 want=6 regex=Lite

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{ 
   "cpanelresult":{ 
      "apiversion":2,
      "func":"search",
      "data":[ 
         { 
            "info":"Fast and Safe little cache system",
            "docurl":"http://pear.php.net/package/Cache_Lite/docs",
            "latest":"1.7.16",
            "installed":"stable",
            "module":"Cache_Lite",
            "stable":"stable"
         },
         { 
            "info":"a lightweight and fast Config class for ini style text configuration files.",
            "docurl":"http://pear.php.net/package/Config_Lite/docs",
            "latest":"1.7.15",
            "installed":"0.2.1",
            "module":"Config_Lite",
            "stable":"0.2.1"
         },
         { 
            "info":"DB_Sqlite_Tools is an object oriented interface to effectively manage and backup Sqlite databases.",
            "docurl":"http://pear.php.net/package/DB_Sqlite_Tools/docs",
            "latest":"beta",
            "installed":"0.1.7",
            "module":"DB_Sqlite_Tools",
            "stable":"0.1.7"
         },
         { 
            "info":"sqlite MDB2 driver",
            "docurl":"http://pear.php.net/package/MDB2_Driver_sqlite/docs",
            "latest":"alpha",
            "installed":"1.5.0b4",
            "module":"MDB2_Driver_sqlite",
            "stable":"1.5.0b4"
         }
      ],
      "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.	A available scripting language on your server. Note: The LangMods::langlistfunction returns possible values.	perl
skip	integer	The number of responses to skip at the beginning of the function's output. Use this parameter with the wantparameter to paginate the function's output. This value defaults to 0.	A positive integer.	3
want	integer	The number of responses to return in the function's output. This value defaults to 100.	A positive integer.	6
regex	string	Required A Perl Compatible Regular Expression (PCRE) that filters the results.	A valid PCRE.	Lite

Returns

Return	Type	Description	Possible values	Example
info	string	Any relevant information about the module.	A string value.	sqlite MDB2 driver
docurl	string	The system's homepage.	A URL.	http://pear.php.net/package/MDB2_Driver_sqlite/docs
latest	string	The module's latest version.	A module version number.	alpha
installed	string	The module's installed version.	A module version number. null — The module is not installed.	1.5.0b4
module	string	The module's name.	A module name.	MDB2_Driver_sqlite
stable	string	The module's stable version.	A module version number.	1.5.0b4
reason	string	A reason for failure. Note: This function only returns areasonvalue 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