cPanel API 2 Functions - LangMods::install

Warning:

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

Description

This function installs a cPanel-supported language module.

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=install&lang=php-pear&mod=Config_Lite&quiet=1

Note:

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

LiveAPI PHP Class

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

// Install the Config_Lite php-pear module.
$install_module = $cpanel->api2(
    'LangMods', 'install',
        array(
            'lang'          => 'php-pear',
            'mod'           => 'Config_Lite'
            'quiet'         => '1'
     )
  );

Note:

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

LiveAPI Perl Module

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

# Install the Config_Lite php-pear module.
my $install_module = $cpliveapi->api2(
    'LangMods', 'install',
        {
            'lang'          => 'php-pear',
            'mod'           => 'Config_Lite'
            'quiet'         => '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

cpapi2 --user=username LangMods install lang=php-pear mod=Config_Lite quiet=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:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "install",
    "data": [
      {
        "status": 1,
        "result": "downloading Config_Lite-0.2.1.tar ...\nStarting to download Config_Lite-0.2.1.tar (Unknown size)\n.............done: 56,320 bytes\ninstall ok: channel://pear.php.net/Config_Lite-0.2.1\n"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "LangMods"
  }
}

Note:

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

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`lang`	string	Required The scripting language's short name.	An available scripting language's short name. The `LangMods::langlist` function returns possible values.	`php-pear`
`mod`	string	Required The module to install.	A language module.	`Config_Lite`
`quiet`	Boolean	Required Whether to return a `result` value.	`1` — Return output. `0` — Do not return output.	`1`

lang

string

Required

The scripting language's short name.

An available scripting language's short name.

The LangMods::langlist function returns possible values.

php-pear

mod

string

Required

The module to install.

A language module.

Config_Lite

quiet

Boolean

Required

Whether to return a result value.

1 — Return output.
0 — Do not return output.

1

Returns

Return	Type	Description	Possible values	Example
`status`	Boolean	Whether the module installed.	`1` — Installed. `0` — Did not install.	`1`
`result`	string	Any relevant installation information.	A string value.	`"downloading Config_Lite-0.2.1.tar ...\nStarting to download Config_Lite-0.2.1.tar (Unknown size)\n.............done: 56,320 bytes\ninstall ok: channel://pear.php.net/Config_Lite-0.2.1\n"`
`reason`	string	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.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`