cPanel API 2 Functions - LangMods::setup - Knowledgebase

Description

This function determines whether the account has the necessary requirements for the cPanel module installer.

Warning:

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

Note:

We recommend that you run cPanel API 2's LangMods::pre_run function after you call this function.

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=setup&lang=perl

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Retrieve module installer requirements on example.com.
$get_installer_requirements = $cpanel->api2(
    'LangMods', 'setup',
        array(
            'lang'          => 'perl',
        )
  );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Retrieve modular requirements for perl on example.com.
my $get_installer_requirements = $cpliveapi->api2(
    'LangMods', 'setup',
        {
        'lang'          => 'perl',
        }
  );

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only 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": "setup",
    "data": [
      {
        "status": 1,
        "result": null
      }
    ],
    "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's short name. Note: The LangMods::langlist function returns possible values.	ruby

Parameter

Type

Description

Possible values

Example

lang

string

Required

The scripting language's short name.

A available scripting language's short name.

Note:

The LangMods::langlist function returns possible values.

ruby

Returns

Return	Type	Description	Possible values	Example
status	boolean	Whether all of the requirements are present.	1 — Present. 0 — Missing.	1
result	string	Any relevant requirements information.	A list of missing requirements. "" or null — No relevant information.	null
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