Child pages
  • UAPI Functions - Features::list_features
Skip to end of metadata
Go to start of metadata

Description

This function lists a cPanel 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 cPanel account's features
$instances = $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 cPanel account's features.
my $instances = $cpliveapi->uapi(
    'Features', 'list_features',
);


Note:

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

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


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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
   "result":{
      "messages":null,
      "metadata":{
      },
      "data":{
		 "bbs":0,
		 "chat":0,
         "spamassassin":1,
         "emailarchive":1,
         "updatecontact":1,
         "defaultaddress":1,
         "emailauth":1,
         "popaccts":1,
         "blockers":1,
         "spambox":1,
         "boxtrapper":1,
         "emaildomainfwd":1,
         "traceaddy":1,
         "email_disk_usage":1,
         "changemx":1,
         "webmail":1,
         "emailtrace":1
      },
      "errors":null,
      "warnings":null,
      "status":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:

This function returns a hash of Boolean values that use the name of features available to the account.

ReturnTypeDescriptionPossible valuesExample

feature name

Boolean

Whether the feature is installed.

Notes:

  • The return's name is the feature's name.
  • This function returns features that third-party software or plugins provide.
  • 1 — Installed.
  • 0Not installed.
0