Child pages
  • WHM API 1 Functions - get_available_featurelists

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description


Excerpt

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


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


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/get_available_featurelists?api.version=1



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/get_available_featurelists?api.version=1



Expand
titleCommand Line


Code Block
languagebash
whmapi1 get_available_featurelists

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
    "data": {
        "available_featurelists": [
            "default",
            "disabled",
            "reseller1_test1",
            "reseller1_test2"
        ]
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "get_available_featurelists"
    }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<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>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


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