Child pages
  • cPanel API 2 Functions - LangMods::setup
Skip to end of metadata
Go to start of metadata

Description

This function determines whether the account meets the 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


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.
 
// Retrieve module installer requirements on example.com.
$get_installer_requirements = $cpanel->api2(
    'LangMods', 'setup',
		array(
			'lang'			=> 'perl',
		)
  );


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.
 
# Retrieve modular requirements for perl on example.com.
my $get_installer_requirements = $cpliveapi->api2(
    'LangMods', 'setup',
		{
		'lang'			=> 'perl',
		}
  );


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

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


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • 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": "setup",
    "data": [
      {
        "status": 1,
        "result": null
      }
    ],
    "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.

A available scripting language's short name.

Note:

The LangMods::langlist function returns possible values.

perl

 

Returns

ReturnTypeDescriptionPossible valuesExample
status Boolean

Whether all of the requirements are present.

  • 1 — Present.
  • 0 — Missing.
1
resultstring

Any relevant requirements information.

  • A list of missing requirements.
  • "" or null — No relevant information.
null
reasonstring

A reason for failure.

Note:

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