Page tree

Versions Compared

Key

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

Description

Excerpt

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

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/get_feature_metadata?api.version=1
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/get_feature_metadata?api.version=1
Expand
titleCommand Line
Code Block
languagebash
whmapi1 get_feature_metadata

Include Page
_WHMAPI1CLINote
_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "data": {
    "features": [
      {
        "is_plugin": "0",
        "name": "Site Software",
        "id": "addoncgi",
        "is_cpaddon": "0"
      },
      {
        "is_plugin": "0",
        "name": "Addon Domain Manager",
        "id": "addondomains",
        "is_cpaddon": "0"
      },
	...
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "get_feature_metadata"
  }
}
Expand
titleOutput (XML)
<result>
    <data>
        <features>
            <is_plugin>0</is_plugin>
            <name>Site Software</name>
            <id>addoncgi</id>
            <is_cpaddon>0</is_cpaddon>
        </features>
        <features>
            <is_plugin>0</is_plugin>
            <name>Addon Domain Manager</name>
            <id>addondomains</id>
            <is_cpaddon>0</is_cpaddon>
        </features>
	...
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>get_feature_metadata</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample
featuresarray of hashesAn array of hashes of each feature's information.

This array includes hashes of feature information. Each hash includes the is_plugin, name, id, and is_cpaddon returns.

 

is_plugin

Boolean

Whether the feature is a plugin.

The function returns this value in the features array.

  • 1 — Plugin.
  • 0Not a plugin.
0

name

string

The feature's name.

This function returns this value in the feature array.

A valid string.Addon Domain Manager

id

string

The feature's ID.

This function returns this value in the feature array.

A valid feature name.addondomains

is_cpaddon

Boolean

Whether the feature is a cPAddon.

The function returns this value in the features array.

  • 1 — cPAddon.
  • 0Not a cPAddon.
0