cPanel API 2 Functions - LangMods::langlist

Description

This function lists the server's available scripting languages.

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=langlist

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Retrieve list of available languages.
$get_lang_list $cpanel->api2(
    'LangMods''langlist',
         
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Retrieve list of available languages.
my $get_lang_list $cpliveapi->api2(
    'LangMods''langlist',
 
        )
  );

 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": "langlist",
    "data": [
      {
        "lang": "perl",
        "name": "Perl Module"
      },
      {
        "lang": "php-pear",
        "name": "PHP Extensions and Applications Package"
      },
      {
        "lang": "ruby",
        "name": "Ruby Gem"
      },
      {
        "lang": "php-pecl",
        "name": "PHP Pecl"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "LangMods"
  }
}

Note:

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

 

Parameters

This function does not accept parameters.

 

Returns

 Return 

Type

Description

Possible values

Example

 lang

 string

 The language system's short name.

 The language system's short name. 

 Perl

 name

 string

 The language system's long name.

 The language system's long name.

 Perl Module

 reason

 string

 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. 

 result

 boolean 

 Whether the function succeeded.

  • 1 — The function succeeded. 
  • 0 — The function failed.

 1

 

  • 6 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....