Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists an account's features.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Features/list_features

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the account's features
$Features_list_features = $cpanel->uapi(
    'Features', 'list_features'
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List the account's features.
my $Features_list_features = $cpliveapi->uapi(
    'Features', 'list_features',
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- List the account's features . -->
[% data = execute( 'Features', 'list_features' ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Features list_features

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    
  },
  "data": {
    "sslmanager": "1",
    "emailtrace": "1",
    "password": "1",
    "dirselector": "1",
    "autoresponders": "1",
    "setlang": "1",
    "php-config": "1",
    "enduserlve": "1",
    "cgi": "1",
    "webprotect": "1",
    "postgres": "1",
    "popaccts": "1",
    "redirects": "1",
    "randhtml": "1",
    "advguest": "1",
    "getstart": "1",
    "emailarchive": "1",
    "updatenotificationprefs": "1",
    "modsecurity": "1",
    "csvimport": "1",
    "guest": "1",
    "subdomainstats": "1",
    "mime": "1",
    "diskusageviewer": "1",
    "optimizews": "1",
    "clamavconnector_scan": "1",
    "fantastico": "0",
    "statmanager": "1",
    "cpanelpro_images": "1",
    "pgp": "1",
    "awstats": "1",
    "backup": "1",
    "phpmyadmin": "1",
    "emailscripts": "1",
    "errlog": "1",
    "webmail": "1",
    "style": "1",
    "cpanelpro_support": "0",
    "handlers": "1",
    "cron": "1",
    "bandwidth": "1",
    "subdomains": "1",
    "ipdeny": "1",
    "zoneedit": "1",
    "counter": "1",
    "nettools": "1",
    "emailauth": "1",
    "searchsubmit": "0",
    "simplezoneedit": "1",
    "ssh": "1",
    "videotut": "1",
    "boxtrapper": "1",
    "lastvisits": "1",
    "cpanelpro_leechprotect": "1",
    "bbs": "0",
    "ftpsetup": "1",
    "spambox": "1",
    "entropybanner": "1",
    "webdisk": "1",
    "sslinstall": "1",
    "modules-ruby": "1",
    "hotlink": "1",
    "blockers": "1",
    "ror": "1",
    "traceaddy": "1",
    "statselect": "1",
    "backupwizard": "1",
    "updatecontact": "1",
    "lists": "1",
    "theme-switch": "1",
    "api_shell": "1",
    "scgiwrap": "1",
    "errpgs": "1",
    "agora": "1",
    "analog": "1",
    "changemx": "1",
    "phppgadmin": "1",
    "addoncgi": "1",
    "parkeddomains": "1",
    "modules-perl": "1",
    "defaultaddress": "1",
    "addondomains": "1",
    "indexmanager": "1",
    "filemanager": "1",
    "modules-php-pear": "1",
    "spamassassin": "1",
    "serverstatus": "1",
    "chat": "0",
    "forwarders": "1",
    "rawlog": "1",
    "mysql": "1",
    "clock": "1",
    "entropysearch": "1",
    "webalizer": "1",
    "ftpaccts": "1",
    "emaildomainfwd": "1",
    "countdown": "1"
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

This function does not accept parameters.

Returns

Note:

The function returns a hash of boolean values that use the name of each feature that is available to the account, and whether they are installed.

ReturnTypeDescriptionPossible valuesExample
feature name
Boolean

Whether the feature is installed.

Note:

The parameter's name is the feature's name.

  • 1 — Installed.
  • 0Not installed.
0