Child pages
  • WHM API 0 Functions - getfeaturelist
Skip to end of metadata
Go to start of metadata

Description

This function lists features that are available to the authenticated user.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/getfeaturelist
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/getfeaturelist
 Command Line
whmapi0 getfeaturelist


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 0 documentation or run the whmapi0 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi0 command:

    /usr/local/cpanel/bin/api/whmapi0

 Output (JSON)
{
      "feature":[
         {
            "id":"modules-perl",
            "name":"Install Perl Modules"
         },
         {
            "id":"modules-php-pear",
            "name":"Install PHP Pear Modules"
         },
         {
            "id":"agora",
            "name":"Agora Shopping Cart"
         },
         {
            "id":"boxtrapper",
            "name":"BoxTrapper Spam Trap"
         },
         {
            "id":"fantastico",
            "name":"Fantastico"
         }
      ]
}
 Output (XML)
<getfeaturelist>
   <feature>
      <name>Install Perl Modules</name>
      <id>modules-perl</id>
   </feature>
   <feature>
      <name>Install PHP Pear Modules</name>
      <id>modules-php-pear</id>
   </feature>
   <feature>
      <name>Agora Shopping Cart</name>
      <id>agora</id>
   </feature>
   <feature>
      <name>BoxTrapper Spam Trap</name>
      <id>boxtrapper</id>
   </feature>
   <feature>
      <name>Forwarder Manager</name>
      <id>forwarders</id>
   </feature>
   <feature>
      <name>Redirect Manager</name>
      <id>redirects</id>
   </feature>
   <feature>
      <name>Analog Stats</name>
      <id>analog</id>
   </feature>
   <feature>
      <name>Webalizer Stats</name>
      <id>webalizer</id>
   </feature>
   <feature>
      <name>Server Status Viewer</name>
      <id>serverstatus</id>
   </feature>
   <feature>
      <name>Email Filtering Manager</name>
      <id>blockers</id>
   </feature>
</getfeaturelist>

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample

feature

array of hashes

An array of hashes of feature information.

This array of hashes includes the name and id returns. 

name

string

The feature's name.

The function returns this value in the feature hash.

Note:

This function returns features that third-party software or plugins provide.

A valid string.Install Perl Modules

id

string

The feature's ID.

The function returns this value in the feature hash.

A valid feature name.modules-perl