Child pages
  • WHM API 1 Functions - get_featurelist_data

Versions Compared

Key

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

Description


Excerpt

This function lists features in a specific feature list.


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/get_featurelist_data?api.version=1&featurelist=Mail%20Only



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/get_featurelist_data?api.version=1&featurelist=Mail%20Only



Expand
titleCommand Line


Code Block
languagebash
whmapi1 get_featurelist_data featurelist=\"Mail Only\"

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "data": {
    "features": [
      {
        "is_disabled": "0",
        "value": "0",
        "id": "sslmanager"
      },
      {
        "is_disabled": "0",
        "value": "1",
        "id": "emailtrace"
      },
      ...
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "getfeaturelist"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
    <data>
        <features>
            <is_disabled>0</is_disabled>
            <value>0</value>
            <id>sslmanager</id>
        </features>
        <features>
            <is_disabled>0</is_disabled>
            <value>1</value>
            <id>emailtrace</id>
        </features>
		...
        <featurelist>Mail Only</featurelist>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>get_featurelist_data</command>
    </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ReturnTypeDescriptionPossible valuesExample

featurelist

string

Required

The feature list for which to list information.

An existing feature list name.Mail Only

Returns

ReturnTypeDescriptionPossible valuesExample

feature

array of hashes

An array of hashes of feature information.

This array includes hashes of feature information. Each hash includes the is_disabled, value, and id returns. 

is_disabled

Boolean

Whether the feature is disabled.

This function returns this value in the feature array.

  • 1 — Disabled.
  • 0 — Not disabled.
0

value

Boolean

Whether the feature is turned on.

This function returns this value in the feature array.

  • 1 — On.
  • 0 — Off.
1

id

string

The feature's ID.

This function returns this value in the feature array.

A valid feature name.email_trace