# cPanel API 2 Functions - LangMods::list_available

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function lists a language module system's available modules.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=LangMods&cpanel_jsonapi_func=list_available&lang=php-pear&skip=3&want=6
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


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

# Retrieve available php-pear modules on example.com.
$get_phppear_modules = $cpliveapi->api2(
    'LangMods', 'list_available',
        array(
        'lang'          => 'php-pear',
        'skip'          => '3',
        'want'          => '6',
     )
  );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


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

// Retrieve available php-pear modules on example.com.
my $get_phppear_modules = $cpanel->api2(
    'LangMods', 'list_available',
    {
        'lang'      => 'php-pear',
        'skip'      => '3',
        'want'      => '6',
     }
 );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username LangMods list_available lang=php-pear skip=3 want=6
```

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "list_available",
    "data": [
      {
        "info": "Your configuration's swiss-army knife.",
        "docurl": "http://pear.php.net/package/Config/docs",
        "latest": "1.10.12",
        "installed": null,
        "module": "Config",
        "stable": "1.10.12"
      },
      {
        "info": "a lightweight and fast Config class for ini style text configuration files.",
        "docurl": "http://pear.php.net/package/Config_Lite/docs",
        "latest": "0.2.1",
        "installed": null,
        "module": "Config_Lite",
        "stable": "0.2.1"
      },
      {
        "info": "This Class allows you to easily use ANSI console colors in your application.",
        "docurl": "http://pear.php.net/package/Console_Color/docs",
        "latest": "1.0.3",
        "installed": null,
        "module": "Console_Color",
        "stable": "1.0.3"
      },
      {
        "info": "This Class allows you to easily use ANSI console colors in your application.",
        "docurl": "http://pear.php.net/package/Console_Color2/docs",
        "latest": "0.1.2",
        "installed": null,
        "module": "Console_Color2",
        "stable": "0.1.2"
      },
      {
        "info": "A full featured command line options and arguments parser",
        "docurl": "http://pear.php.net/package/Console_CommandLine/docs",
        "latest": "1.2.0",
        "installed": null,
        "module": "Console_CommandLine",
        "stable": "1.2.0"
      },
      {
        "info": "A command-line arguments parser",
        "docurl": "http://pear.php.net/package/Console_Getargs/docs",
        "latest": "1.3.5",
        "installed": null,
        "module": "Console_Getargs",
        "stable": "1.3.5"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "LangMods"
  }
}
```

Note:
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
thead
tr
th
Parameter
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
lang
td
em
string
td
p
strong
Required
p
The scripting language's short name.
td
p
An available scripting language's short name.
p
For a list of possible values, read our 
a
code
LangMods::langlist
  documentation.
td
code
perl
tr
td
code
skip
td
em
integer
td
p
The number of responses to skip at the beginning of the function's output.
p
Use this parameter with the 
code
want
 parameter to paginate the function's output.
p
This value defaults to 
code
0
.
td
A positive integer.
td
code
3
tr
td
code
want
td
em
integer
td
p
The number of responses to return in the function's output.
p
This value defaults to 
code
100
.
td
A positive integer.
td
code
6
## Returns

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
info
td
em
string
td
Any relevant information about the module.
td
A string value.
td
code
Your configuration
'
s swiss-army knife.
tr
td
code
docurl
td
em
string
td
The system's homepage.
td
A URL.
td
code
http://pear.php.net/package/Config/docs
tr
td
code
latest
td
em
string
td
The module's latest version.
td
A module version number.
td
code
1.3.7
tr
td
code
installed
td
em
string
td
The module's installed version.
td
ul
li
A module version number.
li
code
null
 — The module is not installed.
td
code
1.3.3
tr
td
code
module
td
em
string
td
The module's name.
td
A module name.
td
code
Config
tr
td
code
stable
td
em
string
td
p
The module's stable version.
td
A module version number.
td
code
1.3.5
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
 value if there was an error.
td
span
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1