Child pages
  • WHM API 1 Functions - getfeaturelist
Skip to end of metadata
Go to start of metadata

 

Description

This function lists features that are available to the authenticated user.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/getfeaturelist?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/getfeaturelist?api.version=1
 Command Line
whmapi1 getfeaturelist


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data": {
    "feature": [
      {
        "name": "SSL Manager",
        "id": "sslmanager"
      },
      ...
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "getfeaturelist"
  }
}
 Output (XML)
<result>
    <data>
        <feature>
            <name>SSL Manager</name>
            <id>sslmanager</id>
        </feature>
    </data>
     ...
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>getfeaturelist</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

feature

array of hashes

An array of hashes of feature information.

This array contains a hash for each feature. Each hash includes the name and id returns. 

name

string

The feature's name.

This function returns this value in the feature array.

A valid string.Install Perl Modules

id

string

The feature's ID.

This function returns this value in the feature array.

A valid feature name.modules-perl