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

Description

This function lists the details of a cPanel account's available feature lists.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2087/cpsess##########/execute/Features/get_feature_metadata?user=username


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 details of an account's available feature lists.
$instances = $cpanel->uapi(
    'Features', 'get_feature_metadata'
);


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 details of an account's available feature lists.
my $instances = $cpliveapi->uapi(
    'Features', 'get_feature_metadata',
);


Note:

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

 Command Line
uapi --user=username Features get_feature_metadata


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":{
      "status":1,
      "messages":null,
      "errors":null,
      "metadata":{
         "transformed":1
      },
      "data":[
         {
            "name":"Site Software",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"addoncgi"
         },
         {
            "id":"addondomains",
            "is_cpaddon":"0",
            "name":"Addon Domains",
            "is_plugin":"0"
         },
         {
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Agora Shopping Cart",
            "id":"agora"
         },
         {
            "id":"analog",
            "is_cpaddon":"0",
            "name":"Analog Stats",
            "is_plugin":"0"
         },
         {
            "id":"api_shell",
            "is_cpaddon":"0",
            "name":"API Shell (for developers)",
            "is_plugin":"0"
         },
         {
            "is_plugin":"0",
            "name":"Autoresponders",
            "is_cpaddon":"0",
            "id":"autoresponders"
         },
         {
            "is_cpaddon":"0",
            "name":"AutoSSL",
            "is_plugin":"0",
            "id":"autossl"
         },
         {
            "is_cpaddon":"0",
            "name":"Awstats",
            "is_plugin":"0",
            "id":"awstats"
         },
         {
            "id":"backup",
            "name":"Backup Manager",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "id":"bandwidth",
            "name":"Bandwidth Stats",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "id":"bbs",
            "name":"PHPBB2",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "id":"blockers",
            "is_plugin":"0",
            "name":"Email Filtering Manager",
            "is_cpaddon":"0"
         },
         {
            "id":"boxtrapper",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"BoxTrapper"
         },
         {
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Calendars and Contacts",
            "id":"caldavcarddav"
         },
         {
            "name":"CGI Center",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"cgi"
         },
         {
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"MX Entry",
            "id":"changemx"
         },
         {
            "id":"chat",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Chat Rooms"
         },
         {
            "id":"clamavconnector_scan",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Virus Scanner"
         },
         {
            "is_plugin":"0",
            "name":"Java Clock",
            "is_cpaddon":"0",
            "id":"clock"
         },
         {
            "id":"countdown",
            "is_cpaddon":"0",
            "name":"Java Countdown",
            "is_plugin":"0"
         },
         {
            "name":"Counter",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"counter"
         },
         {
            "is_plugin":"0",
            "name":"Images",
            "is_cpaddon":"0",
            "id":"cpanelpro_images"
         },
         {
            "id":"cpanelpro_leechprotect",
            "name":"Leech Protect (requires Directory Privacy)",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "is_plugin":"0",
            "name":"Support System Submission",
            "is_cpaddon":"0",
            "id":"cpanelpro_support"
         },
         {
            "is_cpaddon":"0",
            "name":"Cron Jobs",
            "is_plugin":"0",
            "id":"cron"
         },
         {
            "id":"csvimport",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Address Importer"
         },
         {
            "name":"Default Address",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"defaultaddress"
         },
         {
            "is_cpaddon":"0",
            "name":"Directory Selection Popup",
            "is_plugin":"0",
            "id":"dirselector"
         },
         {
            "id":"diskusageviewer",
            "is_cpaddon":"0",
            "name":"Disk Usage Viewer",
            "is_plugin":"0"
         },
         {
            "is_cpaddon":"0",
            "name":"Manage DNSSEC",
            "is_plugin":"0",
            "id":"dnssec"
         },
         {
            "is_plugin":"0",
            "name":"Email Archiving",
            "is_cpaddon":"0",
            "id":"emailarchive"
         },
         {
            "id":"emailauth",
            "is_cpaddon":"0",
            "name":"Email Deliverability (Authentication)",
            "is_plugin":"0"
         },
         {
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Email Domain Forwarding",
            "id":"emaildomainfwd"
         },
         {
            "id":"emailtrace",
            "is_plugin":"0",
            "name":"Email Trace",
            "is_cpaddon":"0"
         },
         {
            "id":"errlog",
            "name":"Error Log",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "is_plugin":"0",
            "name":"Error Pages",
            "is_cpaddon":"0",
            "id":"errpgs"
         },
         {
            "id":"fantastico",
            "name":"Fantastico",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "is_cpaddon":"0",
            "name":"File Manager",
            "is_plugin":"0",
            "id":"filemanager"
         },
         {
            "id":"filerestoration",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"File and Directory Restoration"
         },
         {
            "id":"forwarders",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Forwarder Manager"
         },
         {
            "id":"ftpaccts",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"FTP Account Manager"
         },
         {
            "name":"FTP Settings",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"ftpsetup"
         },
         {
            "is_plugin":"0",
            "name":"Getting Started Wizard",
            "is_cpaddon":"0",
            "id":"getstart"
         },
         {
            "name":"Configure Greylisting",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"greylist"
         },
         {
            "name":"Apache Handlers",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"handlers"
         },
         {
            "is_plugin":"0",
            "name":"Hotlink Protection",
            "is_cpaddon":"0",
            "id":"hotlink"
         },
         {
            "is_cpaddon":"0",
            "name":"Index Manager",
            "is_plugin":"0",
            "id":"indexmanager"
         },
         {
            "id":"ipdeny",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"IP Blocker"
         },
         {
            "id":"lastvisits",
            "is_cpaddon":"0",
            "name":"Latest Visitors",
            "is_plugin":"0"
         },
         {
            "id":"lists",
            "is_plugin":"0",
            "name":"Mailing Lists",
            "is_cpaddon":"0"
         },
         {
            "is_plugin":"0",
            "name":"cPanel Market",
            "is_cpaddon":"0",
            "id":"market"
         },
         {
            "id":"mime",
            "name":"MIME Types",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "name":"Perl Modules",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"modules-perl"
         },
         {
            "name":"PHP Pear Packages",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"modules-php-pear"
         },
         {
            "is_cpaddon":"0",
            "name":"RubyGems",
            "is_plugin":"0",
            "id":"modules-ruby"
         },
         {
            "id":"modsecurity",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"ModSecurity™ Domain Manager"
         },
         {
            "id":"multiphp",
            "is_plugin":"0",
            "name":"MultiPHP Manager",
            "is_cpaddon":"0"
         },
         {
            "id":"multiphp_ini_editor",
            "name":"MultiPHP INI Editor",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "id":"mysql",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"MySQL"
         },
         {
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Track DNS",
            "id":"nettools"
         },
         {
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Optimize Website",
            "id":"optimizews"
         },
         {
            "id":"parkeddomains",
            "name":"Aliases",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "name":"Application Manager",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"passengerapps"
         },
         {
            "is_cpaddon":"0",
            "name":"Password & Security",
            "is_plugin":"0",
            "id":"password"
         },
         {
            "id":"pgp",
            "is_plugin":"0",
            "name":"PGP/GPG",
            "is_cpaddon":"0"
         },
         {
            "id":"php-config",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"See PHP Configuration"
         },
         {
            "id":"phpmyadmin",
            "is_cpaddon":"0",
            "name":"PhpMyAdmin",
            "is_plugin":"0"
         },
         {
            "id":"phppgadmin",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"PhpPgAdmin"
         },
         {
            "is_cpaddon":"0",
            "name":"Email Accounts",
            "is_plugin":"0",
            "id":"popaccts"
         },
         {
            "is_plugin":"0",
            "name":"Email Disk Usage",
            "is_cpaddon":"0",
            "id":"email_disk_usage"
         },
         {
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"PostgreSQL",
            "id":"postgres"
         },
         {
            "id":"rawlog",
            "is_cpaddon":"0",
            "name":"Raw Access Logs",
            "is_plugin":"0"
         },
         {
            "name":"Redirects",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"redirects"
         },
         {
            "is_plugin":"0",
            "name":"Ruby on Rails",
            "is_cpaddon":"0",
            "id":"ror"
         },
         {
            "is_plugin":"0",
            "name":"Simple CGI Wrapper",
            "is_cpaddon":"0",
            "id":"scgiwrap"
         },
         {
            "id":"searchsubmit",
            "name":"Search Engine Submit Tool",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "is_cpaddon":"0",
            "name":"Server Status Viewer",
            "is_plugin":"0",
            "id":"serverstatus"
         },
         {
            "is_cpaddon":"0",
            "name":"Change Language",
            "is_plugin":"0",
            "id":"setlang"
         },
         {
            "id":"simplezoneedit",
            "name":"Zone Editor (A, CNAME)",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "is_cpaddon":"0",
            "name":"Site Publisher",
            "is_plugin":"0",
            "id":"sitepublisher"
         },
         {
            "id":"spamassassin",
            "is_cpaddon":"0",
            "name":"Apache SpamAssassin™",
            "is_plugin":"0"
         },
         {
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Apache SpamAssassin™ Spam Box",
            "id":"spambox"
         },
         {
            "id":"ssh",
            "is_plugin":"0",
            "name":"SSH Access & Terminal",
            "is_cpaddon":"0"
         },
         {
            "id":"sslinstall",
            "is_cpaddon":"0",
            "name":"SSL Host Installer",
            "is_plugin":"0"
         },
         {
            "name":"SSL/TLS",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"sslmanager"
         },
         {
            "name":"Metrics Editor",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"statselect"
         },
         {
            "id":"style",
            "is_plugin":"0",
            "name":"Change Style",
            "is_cpaddon":"0"
         },
         {
            "is_plugin":"0",
            "name":"Subdomains",
            "is_cpaddon":"0",
            "id":"subdomains"
         },
         {
            "id":"subdomainstats",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Subdomain Stats"
         },
         {
            "is_cpaddon":"0",
            "name":"Theme Switching",
            "is_plugin":"0",
            "id":"theme-switch"
         },
         {
            "id":"tls_wizard",
            "name":"SSL/TLS Wizard",
            "is_cpaddon":"0",
            "is_plugin":"0"
         },
         {
            "id":"traceaddy",
            "is_cpaddon":"0",
            "name":"Email Delivery Route (deprecated)",
            "is_plugin":"0"
         },
         {
            "is_cpaddon":"0",
            "name":"Two-Factor Authentication (Google Authenticator)",
            "is_plugin":"0",
            "id":"twofactorauth"
         },
         {
            "is_cpaddon":"0",
            "name":"Contact Information",
            "is_plugin":"0",
            "id":"updatecontact"
         },
         {
            "id":"updatenotificationprefs",
            "is_plugin":"0",
            "name":"Update Notification Preferences",
            "is_cpaddon":"0"
         },
         {
            "id":"version_control",
            "is_cpaddon":"0",
            "name":"Git™ Version Control",
            "is_plugin":"0"
         },
         {
            "id":"videotut",
            "is_plugin":"0",
            "is_cpaddon":"0",
            "name":"Video Tutorials"
         },
         {
            "name":"Webalizer",
            "is_cpaddon":"0",
            "is_plugin":"0",
            "id":"webalizer"
         },
         {
            "id":"webdisk",
            "is_plugin":"0",
            "name":"Web Disk",
            "is_cpaddon":"0"
         },
         {
            "id":"webmail",
            "is_plugin":"0",
            "name":"Webmail",
            "is_cpaddon":"0"
         },
         {
            "is_plugin":"0",
            "name":"Directory Privacy",
            "is_cpaddon":"0",
            "id":"webprotect"
         },
         {
            "is_cpaddon":"0",
            "name":"Zone Editor (AAAA, CAA, SRV, TXT)",
            "is_plugin":"0",
            "id":"zoneedit"
         },
         {
            "is_plugin":"1",
            "is_cpaddon":"0",
            "name":"CPU and Concurrent Connection Usage",
            "id":"enduserlve"
         },
         {
            "id":"ea-php55",
            "is_cpaddon":"0",
            "name":"EA4 - Allow PHP 5.5",
            "is_plugin":"1"
         },
         {
            "is_cpaddon":"0",
            "name":"EA4 - Allow PHP 5.6",
            "is_plugin":"1",
            "id":"ea-php56"
         },
         {
            "id":"ea-php54",
            "name":"EA4 - Allow PHP 5.4",
            "is_cpaddon":"0",
            "is_plugin":"1"
         },
         {
            "is_plugin":"1",
            "name":"WordPress Manager",
            "is_cpaddon":"0",
            "id":"wordpress_manager"
         },
         {
            "is_plugin":"0",
            "name":"WordPress (cPanel)",
            "is_cpaddon":"1",
            "id":"cPanel::Blogs::WordPressX"
         }
      ],
      "warnings":null
   }
}


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

ReturnTypeDescriptionPossible valuesExample
dataarray of hashesAn array of hashes that contains feature information.

Each hash contains 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 data array.

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

name

string

The feature's name.

This function returns this value in the data array.

A valid string.Wordpress Manager

id

string

The feature's system ID.

This function returns this value in the data array.

A valid feature name.wordpress_manager

is_cpaddon

Boolean

Whether the feature is a cPAddon.

The function returns this value in the data array.

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