cPanel API 2 Functions - LangMods::getkey

Warning:

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

Description

This function retrieves a cPanel-supported scripting language's key, or long name.

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=getkey&lang=php-pear&key=name

Note:

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

LiveAPI PHP Class

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

# Return key name for PHP-Pear on example.com.
my $get_arch = $cpliveapi->api2(
    'LangMods', 'getkey',
        array(
        'lang'          => 'php=pear',
        'key'           => 'name'
     )
  );

Note:

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

LiveAPI Perl Module

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

// Return key name for PHP-Pear on example.com.
$get_key_name = $cpanel->api2(
    'LangMods', 'getkey',
    {
        'lang'      => 'php-pear',
        'key'       => 'name'
     }
 );

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 getkey lang=php-pear key=name

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":"getkey",
      "data":[  
         {  
            "key":"PHP Extensions and Applications Package"
         }
      ],
      "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.	Any available scripting language. The `LangMods::langlist` function returns possible values.	`php-pear`
`key`	string	Required Whether to return a scripting language's singular or plural name.	`name` — The language's singular name. `names` — The language's plural names, if available.	`name`

lang

string

Required

The scripting language's short name.

Any available scripting language.

The LangMods::langlist function returns possible values.

php-pear

key

string

Required

Whether to return a scripting language's singular or plural name.

name — The language's singular name.
names — The language's plural names, if available.

name

Returns

Return	Type	Description	Possible values	Example
`key`	string	The scripting language's long name.	The scripting language's name. `null` — The function returns this value if you pass the names value and the language's long name is singular.	`PHP Extensions and Applications Package`
`status`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`
`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`