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

Description


This function lists the authenticated user's available feature lists.

Notes:

  • The root account returns all feature lists on the server.
  • Resellers only return feature lists that the account owns.

Examples 


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


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": {
        "available_featurelists": [
            "default",
            "disabled",
            "reseller1_test1",
            "reseller1_test2"
        ]
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "get_available_featurelists"
    }
}
 Output (XML)
<result>
    <data>
        <available_featurelists>default</available_featurelists>
        <available_featurelists>disabled</available_featurelists>
        <available_featurelists>reseller1_test1</available_featurelists>
        <available_featurelists>reseller1_test2</available_featurelists>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>get_available_featurelists</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

available_featurelists

array

Aa array of available feature lists.

This array includes the feature lists' names.default