Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists all available features.

Examples 


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

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. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
    "data": {
        "feature": [
            {
                "name": "SSL Manager",
                "id": "sslmanager"
            },
            {
                "name": "Email Trace",
                "id": "emailtrace"
            },
            ...
            {
                "name": "Java Countdown",
                "id": "countdown"
            }
        ]
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "get_feature_names"
    }
}
 Output (XML)
<result>
    <data>
        <feature>
            <name>SSL Manager</name>
            <id>sslmanager</id>
        </feature>
        <feature>
            <name>Email Trace</name>
            <id>emailtrace</name>
        </feature>
        <feature>
            <name>Java Countdown</name>
            <id>countdown</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
featurearray of hashesAn array of hashes of feature names.This array includes hashes of feature information. Each hash includes the name and id returns. 

name

stringThe feature's name.

The function returns this value in the feature array.

A valid string.
SSL Manager

id

string

The feature's ID.

The function returns this value in the feature array.

A valid string.
sslmanager