You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • WHM API 1 Functions - ea4_list_profiles
Skip to end of metadata
Go to start of metadata

Description

This function returns a list of all EasyApache 4 profiles and the packages that each profile provides.

Important:

In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/ea4_list_profiles?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/ea4_list_profiles?api.version=1
 Command Line
whmapi1 ea4_list_profiles


Notes:

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

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
	"metadata": {
		"result": 1,
		"version": 1,
		"command": "ea4_list_profiles",
		"reason": "OK"
	},
	"data": {
		"custom": [
      {
        "desc": "This is the description of my awesome profile.",
        "name": "My New Profile",
        "pkgs": ["this_rpm_does_not_exist", "ea-apache24", "ea-apache24-config", "ea-apache24-config-runtime", "ea-apache24-mod_auth_digest", "ea-apache24-mod_authn_anon", "ea-apache24-mod_authz_dbd", "ea-apache24-mod_authz_dbm", "ea-apache24-mod_bwlimited", "ea-apache24-mod_cgi", "ea-apache24-mod_dbd", "ea-apache24-mod_deflate", "ea-apache24-mod_expires", "ea-apache24-mod_headers", "ea-apache24-mod_mpm_prefork", "ea-apache24-mod_proxy", "ea-apache24-mod_proxy_fcgi", "ea-apache24-mod_proxy_http", "ea-apache24-mod_proxy_wstunnel", "ea-apache24-mod_ruid2", "ea-apache24-mod_security2", "ea-apache24-mod_ssl", "ea-apache24-mod_unique_id", "ea-apache24-tools", "ea-apr", "ea-apr-util", "ea-brotli", "ea-cpanel-tools", "ea-documentroot", "ea-libargon2", "ea-libcurl", "ea-libmcrypt", "ea-libnghttp2", "ea-libxml2", "ea-modsec-sdbm-util", "ea-nghttp2", "ea-openssl11", "ea-php-cli", "ea-php-cli-lsphp", "ea-php71", "ea-php71-libc-client", "ea-php71-pear", "ea-php71-php-bcmath", "ea-php71-php-calendar", "ea-php71-php-cli", "ea-php71-php-common", "ea-php71-php-curl", "ea-php71-php-devel", "ea-php71-php-fpm", "ea-php71-php-ftp", "ea-php71-php-gd", "ea-php71-php-iconv", "ea-php71-php-imap", "ea-php71-php-ioncube10", "ea-php71-php-litespeed", "ea-php71-php-mbstring", "ea-php71-php-mcrypt", "ea-php71-php-mysqlnd", "ea-php71-php-pdo", "ea-php71-php-posix", "ea-php71-php-sockets", "ea-php71-php-xml", "ea-php71-runtime", "ea-php72", "ea-php72-libc-client","ea-php72-pear", "ea-php72-php-bcmath", "ea-php72-php-calendar", "ea-php72-php-cli","ea-php72-php-common", "ea-php72-php-curl", "ea-php72-php-devel", "ea-php72-php-fpm", "ea-php72-php-ftp", "ea-php72-php-gd", "ea-php72-php-iconv", "ea-php72-php-imap", "ea-php72-php-litespeed", "ea-php72-php-mbstring", "ea-php72-php-mysqlnd", "ea-php72-php-pdo", "ea-php72-php-posix", "ea-php72-php-sockets", "ea-php72-php-xml", "ea-php72-runtime", "ea-php73", "ea-php73-libc-client", "ea-php73-pear", "ea-php73-php-bcmath", "ea-php73-php-calendar", "ea-php73-php-cli", "ea-php73-php-common", "ea-php73-php-curl", "ea-php73-php-devel", "ea-php73-php-fpm", "ea-php73-php-ftp", "ea-php73-php-gd", "ea-php73-php-iconv", "ea-php73-php-imap", "ea-php73-php-litespeed", "ea-php73-php-mbstring", "ea-php73-php-mysqlnd", "ea-php73-php-pdo", "ea-php73-php-posix", "ea-php73-php-sockets", "ea-php73-php-xml", "ea-php73-runtime", "ea-profiles-cpanel"],
        "version": "0.1",
        "path": "newprofile.json",
        "tags": ["PHP 7.3", "Apache 2.4", "PHP 7.2", "PHP 7.1"],
        "validation_data": {
          "not_on_server": [
				"this_rpm_does_not_exist"]
        }
      }
    ],
		"supervendor": [
      {
        "desc": "This is the vendor's profile.",
        "name": "Vendor Profile",
        "pkgs": ["ea-apache24", "ea-apache24-config", "ea-apache24-config-runtime", "ea-apache24-mod_auth_digest", "ea-apache24-mod_authn_anon", "ea-apache24-mod_authz_dbd", "ea-apache24-mod_authz_dbm", "ea-apache24-mod_bwlimited", "ea-apache24-mod_cgi", "ea-apache24-mod_dbd", "ea-apache24-mod_deflate", "ea-apache24-mod_expires", "ea-apache24-mod_headers", "ea-apache24-mod_mpm_prefork", "ea-apache24-mod_proxy", "ea-apache24-mod_proxy_fcgi", "ea-apache24-mod_proxy_http", "ea-apache24-mod_proxy_wstunnel", "ea-apache24-mod_ruid2", "ea-apache24-mod_security2", "ea-apache24-mod_ssl", "ea-apache24-mod_unique_id", "ea-apache24-tools", "ea-apr", "ea-apr-util", "ea-brotli", "ea-cpanel-tools", "ea-documentroot", "ea-libargon2", "ea-libcurl", "ea-libmcrypt", "ea-libnghttp2", "ea-libxml2", "ea-modsec-sdbm-util", "ea-nghttp2", "ea-openssl11", "ea-php-cli", "ea-php-cli-lsphp", "ea-php71", "ea-php71-libc-client", "ea-php71-pear", "ea-php71-php-bcmath", "ea-php71-php-calendar", "ea-php71-php-cli", "ea-php71-php-common", "ea-php71-php-curl", "ea-php71-php-devel", "ea-php71-php-fpm", "ea-php71-php-ftp", "ea-php71-php-gd", "ea-php71-php-iconv", "ea-php71-php-imap", "ea-php71-php-ioncube10", "ea-php71-php-litespeed", "ea-php71-php-mbstring", "ea-php71-php-mcrypt", "ea-php71-php-mysqlnd", "ea-php71-php-pdo", "ea-php71-php-posix", "ea-php71-php-sockets", "ea-php71-php-xml", "ea-php71-runtime", "ea-php72", "ea-php72-libc-client","ea-php72-pear", "ea-php72-php-bcmath", "ea-php72-php-calendar", "ea-php72-php-cli","ea-php72-php-common", "ea-php72-php-curl", "ea-php72-php-devel", "ea-php72-php-fpm", "ea-php72-php-ftp", "ea-php72-php-gd", "ea-php72-php-iconv", "ea-php72-php-imap", "ea-php72-php-litespeed", "ea-php72-php-mbstring", "ea-php72-php-mysqlnd", "ea-php72-php-pdo", "ea-php72-php-posix", "ea-php72-php-sockets", "ea-php72-php-xml", "ea-php72-runtime", "ea-php73", "ea-php73-libc-client", "ea-php73-pear", "ea-php73-php-bcmath", "ea-php73-php-calendar", "ea-php73-php-cli", "ea-php73-php-common", "ea-php73-php-curl", "ea-php73-php-devel", "ea-php73-php-fpm", "ea-php73-php-ftp", "ea-php73-php-gd", "ea-php73-php-iconv", "ea-php73-php-imap", "ea-php73-php-litespeed", "ea-php73-php-mbstring", "ea-php73-php-mysqlnd", "ea-php73-php-pdo", "ea-php73-php-posix", "ea-php73-php-sockets", "ea-php73-php-xml", "ea-php73-runtime", "ea-profiles-cpanel"],
        "version": "0.1",
        "path": "newprofile.json",
        "tags": ["PHP 7.3", "Apache 2.4", "PHP 7.2", "PHP 7.1"],
        "validation_data": {
          "not_on_server": []
        }
      }
    ],
		"cpanel": [{
			"active": 1,
			"desc": "The currently installed packages on the server.",
			"name": "Current Profile",
			"pkgs": ["ea-apache24", "ea-apache24-config", "ea-apache24-config-runtime", "ea-apache24-mod_bwlimited", "ea-apache24-mod_cgi", "ea-apache24-mod_deflate", "ea-apache24-mod_expires", "ea-apache24-mod_headers", "ea-apache24-mod_mpm_prefork", "ea-apache24-mod_proxy", "ea-apache24-mod_proxy_fcgi", "ea-apache24-mod_proxy_http", "ea-apache24-mod_proxy_wstunnel", "ea-apache24-mod_ruid2", "ea-apache24-mod_security2", "ea-apache24-mod_ssl", "ea-apache24-mod_unique_id", "ea-apache24-tools", "ea-apr", "ea-apr-util", "ea-brotli", "ea-cpanel-tools", "ea-documentroot", "ea-libcurl", "ea-libmcrypt", "ea-libnghttp2", "ea-libxml2", "ea-modsec-sdbm-util", "ea-nghttp2", "ea-openssl", "ea-openssl11", "ea-php-cli", "ea-php-cli-lsphp", "ea-php56", "ea-php56-libc-client", "ea-php56-pear", "ea-php56-php-bcmath", "ea-php56-php-calendar", "ea-php56-php-cli", "ea-php56-php-common", "ea-php56-php-curl", "ea-php56-php-devel", "ea-php56-php-fpm", "ea-php56-php-ftp", "ea-php56-php-gd", "ea-php56-php-imap", "ea-php56-php-litespeed", "ea-php56-php-mcrypt", "ea-php56-php-mysqlnd", "ea-php56-php-pdo", "ea-php56-php-posix", "ea-php56-php-sockets", "ea-php56-php-xml", "ea-php56-runtime", "ea-php70", "ea-php70-libc-client", "ea-php70-pear", "ea-php70-php-bcmath", "ea-php70-php-calendar", "ea-php70-php-cli", "ea-php70-php-common", "ea-php70-php-curl", "ea-php70-php-devel", "ea-php70-php-fpm", "ea-php70-php-ftp", "ea-php70-php-gd", "ea-php70-php-imap", "ea-php70-php-litespeed", "ea-php70-php-mcrypt", "ea-php70-php-mysqlnd", "ea-php70-php-pdo", "ea-php70-php-posix", "ea-php70-php-sockets", "ea-php70-php-xml", "ea-php70-runtime", "ea-php71", "ea-php71-libc-client", "ea-php71-pear", "ea-php71-php-bcmath", "ea-php71-php-calendar", "ea-php71-php-cli", "ea-php71-php-common", "ea-php71-php-curl", "ea-php71-php-devel", "ea-php71-php-fpm", "ea-php71-php-ftp", "ea-php71-php-gd", "ea-php71-php-iconv", "ea-php71-php-imap", "ea-php71-php-ioncube10", "ea-php71-php-litespeed", "ea-php71-php-mbstring", "ea-php71-php-mcrypt", "ea-php71-php-mysqlnd", "ea-php71-php-pdo", "ea-php71-php-posix", "ea-php71-php-sockets", "ea-php71-php-xml", "ea-php71-runtime", "ea-profiles-cpanel"],
			"validation_data": {
				"not_on_server": []
			},
			"version": "1.0"
		}, {
			"name": "All PHP Options + OpCache",
			"validation_data": {
				"not_on_server": []
			},
			"pkgs": ["ea-apache24", "ea-apr", "ea-apr-util", "ea-php73", "ea-php72", "ea-php71", "ea-apache24-mod_mpm_worker", "ea-apache24-mod_ssl", "ea-apache24-mod_deflate", "ea-apache24-mod_expires", "ea-apache24-mod_headers", "ea-apache24-mod_proxy", "ea-apache24-mod_cgid", "ea-apache24-mod_suexec", "ea-apache24-mod_suphp", "ea-apache24-mod_security2", "ea-apache24-mod_proxy_fcgi", "ea-php73-build", "ea-php73-php-bcmath", "ea-php73-php-bz2", "ea-php73-php-calendar", "ea-php73-php-cli", "ea-php73-php-common", "ea-php73-php-curl", "ea-php73-php-dba", "ea-php73-php-devel", "ea-php73-php-enchant", "ea-php73-php-exif", "ea-php73-php-fileinfo", "ea-php73-php-fpm", "ea-php73-php-ftp", "ea-php73-php-gd", "ea-php73-php-gettext", "ea-php73-php-gmp", "ea-php73-php-iconv", "ea-php73-php-imap", "ea-php73-php-intl", "ea-php73-php-ldap", "ea-php73-php-mbstring", "ea-php73-php-mysqlnd", "ea-php73-php-odbc", "ea-php73-php-opcache", "ea-php73-php-pdo", "ea-php73-php-pgsql", "ea-php73-php-posix", "ea-php73-php-process", "ea-php73-php-pspell", "ea-php73-php-snmp", "ea-php73-php-soap", "ea-php73-php-sockets", "ea-php73-php-tidy", "ea-php73-php-xml", "ea-php73-php-xmlrpc", "ea-php73-php-zip", "ea-php73-runtime", "ea-php72-build", "ea-php72-php-bcmath", "ea-php72-php-bz2", "ea-php72-php-calendar", "ea-php72-php-cli", "ea-php72-php-common", "ea-php72-php-curl", "ea-php72-php-dba", "ea-php72-php-devel", "ea-php72-php-enchant", "ea-php72-php-exif", "ea-php72-php-fileinfo", "ea-php72-php-fpm", "ea-php72-php-ftp", "ea-php72-php-gd", "ea-php72-php-gettext", "ea-php72-php-gmp", "ea-php72-php-iconv", "ea-php72-php-imap", "ea-php72-php-intl", "ea-php72-php-ldap", "ea-php72-php-mbstring", "ea-php72-php-mysqlnd", "ea-php72-php-odbc", "ea-php72-php-opcache", "ea-php72-php-pdo", "ea-php72-php-pgsql", "ea-php72-php-posix", "ea-php72-php-process", "ea-php72-php-pspell", "ea-php72-php-snmp", "ea-php72-php-soap", "ea-php72-php-sockets", "ea-php72-php-tidy", "ea-php72-php-xml", "ea-php72-php-xmlrpc", "ea-php72-php-zip", "ea-php72-runtime", "ea-php71-build", "ea-php71-php-bcmath", "ea-php71-php-bz2", "ea-php71-php-calendar", "ea-php71-php-cli", "ea-php71-php-common", "ea-php71-php-curl", "ea-php71-php-dba", "ea-php71-php-devel", "ea-php71-php-enchant", "ea-php71-php-exif", "ea-php71-php-fileinfo", "ea-php71-php-fpm", "ea-php71-php-ftp", "ea-php71-php-gd", "ea-php71-php-gettext", "ea-php71-php-gmp", "ea-php71-php-iconv", "ea-php71-php-imap", "ea-php71-php-intl", "ea-php71-php-ldap", "ea-php71-php-mbstring", "ea-php71-php-mcrypt", "ea-php71-php-mysqlnd", "ea-php71-php-odbc", "ea-php71-php-opcache", "ea-php71-php-pdo", "ea-php71-php-pgsql", "ea-php71-php-posix", "ea-php71-php-process", "ea-php71-php-pspell", "ea-php71-php-snmp", "ea-php71-php-soap", "ea-php71-php-sockets", "ea-php71-php-tidy", "ea-php71-php-xml", "ea-php71-php-xmlrpc", "ea-php71-php-zip", "ea-php71-runtime"],
			"desc": "This is the MPM Worker cPanel profile plus PHP 7.3 plus every PHP option (sans recode and zendguard due to incompatibilities). This package can host multiple sites and users.",
			"tags": ["Apache 2.4", "PHP 7.3", "PHP 7.2", "PHP 7.1", "All PHP Opts"],
			"path": "allphp-opcache.json",
			"version": "0.3"
		}, {
			"name": "All PHP Options + ZendGuard",
			"validation_data": {
				"not_on_server": []
			},
			"pkgs": ["ea-apache24", "ea-apr", "ea-apr-util", "ea-php72", "ea-php71", "ea-php73", "ea-apache24-mod_mpm_worker", "ea-apache24-mod_ssl", "ea-apache24-mod_deflate", "ea-apache24-mod_expires", "ea-apache24-mod_headers", "ea-apache24-mod_proxy", "ea-apache24-mod_cgid", "ea-apache24-mod_suexec", "ea-apache24-mod_suphp", "ea-apache24-mod_security2", "ea-apache24-mod_proxy_fcgi", "ea-php73-php-bcmath", "ea-php73-php-bz2", "ea-php73-php-calendar", "ea-php73-php-cli", "ea-php73-php-common", "ea-php73-php-curl", "ea-php73-php-dba", "ea-php73-php-devel", "ea-php73-php-enchant", "ea-php73-php-exif", "ea-php73-php-fileinfo", "ea-php73-php-fpm", "ea-php73-php-ftp", "ea-php73-php-gd", "ea-php73-php-gettext", "ea-php73-php-gmp", "ea-php73-php-iconv", "ea-php73-php-imap", "ea-php73-php-intl", "ea-php73-php-ldap", "ea-php73-php-mbstring", "ea-php73-php-mysqlnd", "ea-php73-php-odbc", "ea-php73-php-pdo", "ea-php73-php-pgsql", "ea-php73-php-posix", "ea-php73-php-process", "ea-php73-php-pspell", "ea-php73-php-snmp", "ea-php73-php-soap", "ea-php73-php-sockets", "ea-php73-php-tidy", "ea-php73-php-xml", "ea-php73-php-xmlrpc", "ea-php73-php-zip", "ea-php73-runtime", "ea-php72-php-bcmath", "ea-php72-php-bz2", "ea-php72-php-calendar", "ea-php72-php-cli", "ea-php72-php-common", "ea-php72-php-curl", "ea-php72-php-dba", "ea-php72-php-devel", "ea-php72-php-enchant", "ea-php72-php-exif", "ea-php72-php-fileinfo", "ea-php72-php-fpm", "ea-php72-php-ftp", "ea-php72-php-gd", "ea-php72-php-gettext", "ea-php72-php-gmp", "ea-php72-php-iconv", "ea-php72-php-imap", "ea-php72-php-intl", "ea-php72-php-ldap", "ea-php72-php-mbstring", "ea-php72-php-mysqlnd", "ea-php72-php-odbc", "ea-php72-php-pdo", "ea-php72-php-pgsql", "ea-php72-php-posix", "ea-php72-php-process", "ea-php72-php-pspell", "ea-php72-php-snmp", "ea-php72-php-soap", "ea-php72-php-sockets", "ea-php72-php-tidy", "ea-php72-php-xml", "ea-php72-php-xmlrpc", "ea-php72-php-zip", "ea-php72-runtime", "ea-php71-php-bcmath", "ea-php71-php-bz2", "ea-php71-php-calendar", "ea-php71-php-cli", "ea-php71-php-common", "ea-php71-php-curl", "ea-php71-php-dba", "ea-php71-php-devel", "ea-php71-php-enchant", "ea-php71-php-exif", "ea-php71-php-fileinfo", "ea-php71-php-fpm", "ea-php71-php-ftp", "ea-php71-php-gd", "ea-php71-php-gettext", "ea-php71-php-gmp", "ea-php71-php-iconv", "ea-php71-php-imap", "ea-php71-php-intl", "ea-php71-php-ldap", "ea-php71-php-mbstring", "ea-php71-php-mcrypt", "ea-php71-php-mysqlnd", "ea-php71-php-odbc", "ea-php71-php-pdo", "ea-php71-php-pgsql", "ea-php71-php-posix", "ea-php71-php-process", "ea-php71-php-pspell", "ea-php71-php-snmp", "ea-php71-php-soap", "ea-php71-php-sockets", "ea-php71-php-tidy", "ea-php71-php-xml", "ea-php71-php-xmlrpc", "ea-php71-php-zip", "ea-php71-runtime"],
			"desc": "This is the default cPanel profile plus PHP 7.3 plus every PHP option (sans recode and opcache due to incompatibilities). This package can host multiple sites and users.",
			"tags": ["Apache 2.4", "PHP 7.3", "PHP 7.2", "PHP 7.1", "All PHP Opts"],
			"path": "allphp.json",
			"version": "0.2"
		}, {
			"name": "cPanel Default",
			"validation_data": {
				"not_on_server": []
			},
			"pkgs": ["ea-apache24", "ea-apr", "ea-apr-util", "ea-php71", "ea-php72", "ea-php73", "ea-apache24-mod_mpm_prefork", "ea-apache24-mod_ruid2", "ea-apache24-mod_ssl", "ea-apache24-mod_deflate", "ea-apache24-mod_expires", "ea-apache24-mod_headers", "ea-apache24-mod_proxy", "ea-apache24-mod_proxy_fcgi", "ea-apache24-mod_cgi", "ea-apache24-mod_unique_id", "ea-apache24-mod_security2", "ea-php71-php-bcmath", "ea-php71-php-calendar", "ea-php71-php-curl", "ea-php71-php-ftp", "ea-php71-php-gd", "ea-php71-php-iconv", "ea-php71-php-imap", "ea-php71-php-mbstring", "ea-php71-php-mcrypt", "ea-php71-php-mysqlnd", "ea-php71-php-pdo", "ea-php71-php-posix", "ea-php71-php-sockets", "ea-php71-php-xml", "ea-php71-runtime", "ea-php71-php-fpm", "ea-php72-php-bcmath", "ea-php72-php-calendar", "ea-php72-php-curl", "ea-php72-php-ftp", "ea-php72-php-gd", "ea-php72-php-iconv", "ea-php72-php-imap", "ea-php72-php-mbstring", "ea-php72-php-mysqlnd", "ea-php72-php-pdo", "ea-php72-php-posix", "ea-php72-php-sockets", "ea-php72-php-xml", "ea-php72-runtime", "ea-php72-php-fpm", "ea-php73-php-bcmath", "ea-php73-php-calendar", "ea-php73-php-curl", "ea-php73-php-ftp", "ea-php73-php-gd", "ea-php73-php-iconv", "ea-php73-php-imap", "ea-php73-php-mbstring", "ea-php73-php-mysqlnd", "ea-php73-php-pdo", "ea-php73-php-posix", "ea-php73-php-sockets", "ea-php73-php-xml", "ea-php73-runtime", "ea-php73-php-fpm"],
			"desc": "This is the standard Apache package with up-to-date PHP and modules, including PHP-FPM. This package can host multiple sites and users.",
			"tags": ["Apache 2.4", "PHP 7.1", "PHP 7.2", "PHP 7.3"],
			"version": "0.3",
			"path": "default.json"
		}, {
			"name": "cPanel Default + MPM ITK",
			"pkgs": ["ea-apache24", "ea-apr", "ea-apr-util", "ea-php71", "ea-php72", "ea-php73", "ea-apache24-mod_mpm_itk", "ea-apache24-mod_mpm_prefork", "ea-apache24-mod_ssl", "ea-apache24-mod_deflate", "ea-apache24-mod_expires", "ea-apache24-mod_headers", "ea-apache24-mod_proxy", "ea-apache24-mod_cgi", "ea-apache24-mod_proxy_fcgi", "ea-apache24-mod_security2", "ea-php71-php-bcmath", "ea-php71-php-calendar", "ea-php71-php-curl", "ea-php71-php-ftp", "ea-php71-php-gd", "ea-php71-php-imap", "ea-php71-php-mcrypt", "ea-php71-php-mysqlnd", "ea-php71-php-pdo", "ea-php71-php-posix", "ea-php71-php-sockets", "ea-php71-php-xml", "ea-php71-php-fpm", "ea-php72-php-bcmath", "ea-php72-php-calendar", "ea-php72-php-curl", "ea-php72-php-ftp", "ea-php72-php-gd", "ea-php72-php-imap", "ea-php72-php-mysqlnd", "ea-php72-php-pdo", "ea-php72-php-posix", "ea-php72-php-sockets", "ea-php72-php-xml", "ea-php72-php-fpm", "ea-php73-php-bcmath", "ea-php73-php-calendar", "ea-php73-php-curl", "ea-php73-php-ftp", "ea-php73-php-gd", "ea-php73-php-imap", "ea-php73-php-mysqlnd", "ea-php73-php-pdo", "ea-php73-php-posix", "ea-php73-php-sockets", "ea-php73-php-xml", "ea-php73-php-fpm"],
			"validation_data": {
				"not_on_server": []
			},
			"tags": ["Apache 2.4", "PHP 7.1", "PHP 7.2", "PHP 7.3", "MPM ITK"],
			"desc": "This profile includes the modules from the Basic profile but replaces MPM Prefork and Mod Ruid2 with MPM ITK to further increase security for your server. MPM ITK creates a more secure environment than Mod Ruid2, but uses more resources. Note: Some feature of MPM ITK are not compatible with CentOS 6 kernels, see our documentation for more information.",
			"path": "mpm_itk.json",
			"version": "0.2"
		}, {
			"path": "nophp.json",
			"version": "0.1",
			"tags": ["Apache 2.4", "No PHP"],
			"desc": "This Apache web server is beneficial for static content and secure servers. This server does not use PHP support.",
			"pkgs": ["ea-apache24", "ea-apr", "ea-apr-util", "ea-apache24-mod_mpm_worker", "ea-apache24-mod_ssl", "ea-apache24-mod_suexec", "ea-apache24-mod_deflate", "ea-apache24-mod_expires", "ea-apache24-mod_headers", "ea-apache24-mod_proxy", "ea-apache24-mod_cgid", "ea-apache24-mod_security2"],
			"validation_data": {
				"not_on_server": []
			},
			"name": "No PHP"
		}, {
			"desc": "This profile installs standard Apache packages with mod_passenger and ea-ruby24. This profile enables the Application Manager interface in cPanel, which allows users to configure Ruby applications to be deployed via mod_passenger.",
			"tags": ["Apache 2.4", "Ruby 2.4", "Passenger 5.1", "Node.js 10.15"],
			"version": "0.3",
			"path": "rubypassenger.json",
			"name": "Ruby via mod_passenger",
			"validation_data": {
				"not_on_server": []
			},
			"pkgs": ["ea-apache24", "ea-apache24-mod_cgi", "ea-apache24-mod_deflate", "ea-apache24-mod_env", "ea-apache24-mod_expires", "ea-apache24-mod_headers", "ea-apache24-mod_mpm_prefork", "ea-apache24-mod_proxy", "ea-apache24-mod_proxy_fcgi", "ea-apache24-mod_ruid2", "ea-apache24-mod_security2", "ea-apache24-mod_ssl", "ea-apache24-mod_unique_id", "ea-apr", "ea-apr-util", "ea-ruby24", "ea-ruby24-libuv", "ea-ruby24-mod_passenger", "ea-ruby24-ruby", "ea-ruby24-ruby-devel", "ea-ruby24-ruby-doc", "ea-ruby24-rubygem-bigdecimal", "ea-ruby24-rubygem-did_you_mean", "ea-ruby24-rubygem-io-console", "ea-ruby24-rubygem-json", "ea-ruby24-rubygem-minitest", "ea-ruby24-rubygem-mizuho", "ea-ruby24-rubygem-mizuho-doc", "ea-ruby24-rubygem-net-telnet", "ea-ruby24-rubygem-nokogiri", "ea-ruby24-rubygem-nokogiri-doc", "ea-ruby24-rubygem-openssl", "ea-ruby24-rubygem-passenger", "ea-ruby24-rubygem-passenger-doc", "ea-ruby24-rubygem-power_assert", "ea-ruby24-rubygem-psych", "ea-ruby24-rubygem-rack", "ea-ruby24-rubygem-rake", "ea-ruby24-rubygem-rdoc", "ea-ruby24-rubygems", "ea-ruby24-rubygems-devel", "ea-ruby24-rubygem-sqlite3", "ea-ruby24-rubygem-sqlite3-doc", "ea-ruby24-rubygem-test-unit", "ea-ruby24-rubygem-xmlrpc", "ea-ruby24-ruby-irb", "ea-ruby24-ruby-libs", "ea-ruby24-ruby-wrapper", "ea-ruby24-runtime", "ea-nodejs10"]
		}, {
			"path": "worker.json",
			"version": "0.3",
			"desc": "This profile uses the worker MPM and includes suexec, suphp and mod_security2 to improve the security of your server.",
			"tags": ["Apache 2.4", "PHP 7.1", "PHP 7.2", "PHP 7.3"],
			"validation_data": {
				"not_on_server": []
			},
			"pkgs": ["ea-apache24", "ea-apr", "ea-apr-util", "ea-php71", "ea-php72", "ea-php73", "ea-apache24-mod_mpm_worker", "ea-apache24-mod_ssl", "ea-apache24-mod_deflate", "ea-apache24-mod_expires", "ea-apache24-mod_proxy", "ea-apache24-mod_headers", "ea-apache24-mod_cgid", "ea-apache24-mod_suexec", "ea-apache24-mod_suphp", "ea-apache24-mod_security2", "ea-apache24-mod_proxy_fcgi", "ea-php71-php-bcmath", "ea-php71-php-calendar", "ea-php71-php-curl", "ea-php71-php-ftp", "ea-php71-php-gd", "ea-php71-php-imap", "ea-php71-php-mcrypt", "ea-php71-php-mysqlnd", "ea-php71-php-pdo", "ea-php71-php-posix", "ea-php71-php-sockets", "ea-php71-php-xml", "ea-php71-php-fpm", "ea-php72-php-bcmath", "ea-php72-php-calendar", "ea-php72-php-curl", "ea-php72-php-ftp", "ea-php72-php-gd", "ea-php72-php-imap", "ea-php72-php-mysqlnd", "ea-php72-php-pdo", "ea-php72-php-posix", "ea-php72-php-sockets", "ea-php72-php-xml", "ea-php72-php-fpm", "ea-php73-php-bcmath", "ea-php73-php-calendar", "ea-php73-php-curl", "ea-php73-php-ftp", "ea-php73-php-gd", "ea-php73-php-imap", "ea-php73-php-mysqlnd", "ea-php73-php-pdo", "ea-php73-php-posix", "ea-php73-php-sockets", "ea-php73-php-xml", "ea-php73-php-fpm"],
			"name": "cPanel Worker MPM"
		}]
	}
}
 Output (XML)
<result>
  <data>
    <cpanel>
      <name>Current Profile</name>
      <active>1</active>
      <desc>The currently installed packages on the server.</desc>
      <pkgs>ea-apache24</pkgs>
      <pkgs>ea-apache24-config</pkgs>
      …
      <validation_data>
      </validation_data>
      <version>1.0</version>
    </cpanel>
    <cpanel>
      <name>All PHP Options + OpCache</name>
      <desc>This is the MPM Worker cPanel profile plus every PHP option (sans recode and zendguard due to incompatibilities). This package can host multiple sites and users.</desc>
      <path>allphp-opcache.json</path>
      <pkgs>ea-apache24</pkgs>
      <pkgs>ea-apr</pkgs>
      …
      <tags>Apache 2.4</tags>
      <tags>PHP 7.0</tags>
      <tags>PHP 5.5</tags>
      <tags>PHP 5.6</tags>
      <tags>All PHP Opts</tags>
      <validation_data>
      </validation_data>
      <version>0.2</version>
    </cpanel>
    <cpanel>
      <name>All PHP Options + ZendGuard</name>
      <desc>This is the default cPanel profile plus every PHP option (sans recode and opcache due to incompatibilities). This package can host multiple sites and users.</desc>
      <path>allphp.json</path>
      <pkgs>ea-apache24</pkgs>
      <pkgs>ea-apr</pkgs>
      …
      <tags>Apache 2.4</tags>
      <tags>PHP 7.0</tags>
      <tags>PHP 5.5</tags>
      <tags>PHP 5.6</tags>
      <tags>All PHP Opts</tags>
      <validation_data>
      </validation_data>
      <version>0.2</version>
    </cpanel>
    <cpanel>
      <name>cPanel Default</name>
      <desc>This is the standard Apache package with up-to-date PHP and modules, including PHP-FPM. This package can host multiple sites and users.</desc>
      <path>default.json</path>
      <pkgs>ea-apache24</pkgs>
      <pkgs>ea-apr</pkgs>
      …
      <tags>Apache 2.4</tags>
      <tags>PHP 5.5</tags>
      <tags>PHP 5.6</tags>
      <tags>PHP 7.0</tags>
      <validation_data>
      </validation_data>
      <version>0.2</version>
    </cpanel>
    <cpanel>
      <name>cPanel Default + MPM ITK</name>
      <desc>This profile includes the modules from the Basic profile but replaces MPM Worker with MPM ITK to further increase security for your server. MPM ITK creates a more secure environment than Mod Ruid2, but uses more resources.</desc>
      <path>mpm_itk.json</path>
      <pkgs>ea-apache24</pkgs>
      <pkgs>ea-apr</pkgs>
      …
      <tags>Apache 2.4</tags>
      <tags>PHP 7.0</tags>
      <tags>PHP 5.5</tags>
      <tags>PHP 5.6</tags>
      <tags>MPM ITK</tags>
      <validation_data>
      </validation_data>
      <version>0.2</version>
    </cpanel>
    <cpanel>
      <name>No PHP</name>
      <desc>This Apache web server is beneficial for static content and secure servers. This server does not use PHP support.</desc>
      <path>nophp.json</path>
      <pkgs>ea-apache24</pkgs>
      <pkgs>ea-apr</pkgs>
      <pkgs>ea-apr-util</pkgs>
      <pkgs>ea-apache24-mod_mpm_worker</pkgs>
      <pkgs>ea-apache24-mod_ssl</pkgs>
      <pkgs>ea-apache24-mod_suexec</pkgs>
      <pkgs>ea-apache24-mod_deflate</pkgs>
      <pkgs>ea-apache24-mod_expires</pkgs>
      <pkgs>ea-apache24-mod_headers</pkgs>
      <pkgs>ea-apache24-mod_proxy</pkgs>
      <pkgs>ea-apache24-mod_cgid</pkgs>
      <pkgs>ea-apache24-mod_security2</pkgs>
      <tags>Apache 2.4</tags>
      <tags>No PHP</tags>
      <validation_data>
      </validation_data>
      <version>0.1</version>
    </cpanel>
    <cpanel>
      <name>Ruby via mod_passenger</name>
      <desc>This profile installs standard Apache packages with mod_passenger and ea-ruby24. This profile enables the Application Manager interface in cPanel, which allows users to configure Ruby applications to be deployed via mod_passenger.</desc>
      <path>rubypassenger.json</path>
      <pkgs>ea-apache24</pkgs>
      …
      <tags>Apache 2.4</tags>
      <tags>Ruby 2.4</tags>
      <tags>Passenger 5.1</tags>
      <validation_data>
      </validation_data>
      <version>0.3</version>
    </cpanel>
    <cpanel>
      <name>cPanel Worker MPM</name>
      <desc>This profile uses the worker MPM and includes suexec, suphp and mod_security2 to improve the security of your server.</desc>
      <path>worker.json</path>
      <pkgs>ea-apache24</pkgs>
      <pkgs>ea-apr</pkgs>
      …
      <tags>Apache 2.4</tags>
      <tags>PHP 5.5</tags>
      <tags>PHP 5.6</tags>
      <tags>PHP 7.0</tags>
      <validation_data>
      </validation_data>
      <version>0.3</version>
    </cpanel>
    <custom>
      <name>Test</name>
      <desc></desc>
      <path> foo bar.json</path>
      <pkgs>ea-apache24</pkgs>
      <validation_data>
      </validation_data>
      <version>0.1</version>
    </custom>
  </data>
    <metadata>
        <result>1</result>
        <version>1</version>
        <reason>OK</reason>
        <command>ea4_list_pkgs</command>
    </metadata>
	
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

Note:

This function returns the version, desc, name, path, pkgs, tags, and validation_data returns in the cpanel, custom, and vendor_name arrays of hashes. 


ReturnTypeDescriptionPossible valuesExample
cpanelarray of hashesAn array of cPanel & WHM-provided EasyApache 4 profile settings hashes.

This array of hashes includes the version, desc, name, path, pkgs, active, and tags returns and the validation_data array.



active

Boolean

Whether the cPanel & WHM-provided EasyApache 4 profile's settings are active.

The function returns this value in the cpanel array of hashes.

  • 1 — Active.
  • 0 — Inactive.
1
customarray of hashes

An array of custom settings hashes.

Note:

This function returns the custom array when a system administrator-created profile exists.

This array of hashes includes the version, desc, name, path, pkgs, and tags returns and the validation_data array.

                
vendor_namearray of hashes

An array of vendor settings hashes.

In this return, vendor_name  represents a vendor's name.

Note:

  • This function returns the vendor_name array when a third-party vendor-created profile exists.
  • The function may return this array multiple times. 

This array of hashes includes the version, desc, name, path, pkgs, and tags returns and the validation_data array.


Hash returns 

This function returns the version, desc, name, path, pkgs, tags, and validation_data returns in the cpanel, custom, and vendor_name arrays of hashes. 

ReturnTypeDescriptionPossible valuesExample

version 

string

The profile's current version ID.

The function returns this value in the hashes of the cpanel, custom, and vendor_name array of hashes.

A version ID.

1.2

desc 

string

A description of the profile.

The function returns this value in the hashes of the cpanel, custom, and vendor_name array of hashes.

A description.

The currently installed packages on the server.

name 

string

The profile name.

The function returns this value in the hashes of the cpanel, custom, and vendor_name array of hashes.

A profile name.

No PHP

path 

string

The file name of the profile.

The function returns this value in the hashes of the cpanel, custom, and vendor_name array of hashes.

A system path.

default.json

pkgs 

array

The RPM packages that the profile includes.

The function returns this value in the hashes of the cpanel, custom, and vendor_name array of hashes.

An array of RPM packages.ea-apache24

tags 

array

Labels that highlight key attributes of a profile.

The function returns this value in the hashes of the cpanel, custom, and vendor_name array of hashes.

An array of profile labels.Apache 2.4

validation_data 

array of hashes

The packages that the server's yum repositories do not include. 

The function returns this value in the hashes of the cpanel, custom, and vendor_name array of hashes.

This array of hashes includes the not_on_server array.

not_on_server

array

The packages in the profile that do not exist in any of the server's yum repositories.

The function returns this value in the validation_data array of hashes.

An array of missing RPM packages.ea-apache24