# Return server's configuration settings This function retrieves the configuration settings for the cPanel & WHM server on which an account exists. This is useful, for example, to verify which applications and functionality are available on the account. Endpoint: GET /Variables/get_server_information Version: 11.134.0.5 Security: BasicAuth ## Query parameters: - `name` (string) The server configuration settings to return. Click to view information about the available server configuration settings. * - The cPanel interface's default theme. * - The location of the Exim email filter storage directory. * - Whether the system allows users to park subdomains of the server's hostname. * - Whether the system allows users to create addon domains or aliases that resolve to other servers. * - Whether the system allows users to add domains they didn't register with a domain name registrar. * - The IP address or IP address with a firewall port number that Apache® uses to listen for requests and serve web pages over an unsecured connection. * - The port or IP address that Apache uses to listen for requests and serve web pages over a secure connection. API ShellcPanel >> Home >> Advanced >> API Shell*). * - Whether the user can update their AWStats software. * - Whether the AWStats statistical analysis software interprets visitors' domain names as IP addresses. * - The cPanel directory. * - Whether the account requires database prefixing. * - Whether the system displays links to cPanel feature documentation in the cPanel interface. * - The application that processes DNS management requests. * - The minimum age of files that the system will automatically purge from folders in user home directories. FileProtect* option is enabled. * - The maximum file size, in megabytes (MB), that a user can upload to a server. * - The minimum filesystem quota that the system requires after a file uploads to a server. Home* interface's statistics bar. * - The FTP server. * - The maximum number of directories deep to look for files when you change the PHP handler. User ManagercPanel >> Home >> Preferences >> User Manager*). * - Whether the daemon and other cPanel & WHM services listen on IPv6. * - The DNS nameserver's type. * - The logout redirection URL. * - The mailbox storage format for new accounts. * - The mailserver type. * - The minimum strength for cPanel account passwords. * - The minimum strength for MySQL® or MariaDB® passwords. * - The MySQL or MariaDB hostname or IP address. * - The MySQL or MariaDB version. * - The number of seconds that a PHP script can run before the system terminates it. * - The maximum size, in megabytes (MB), of a POST request. * - The system's default version of PHP. * - The maximum file size, in megabytes (MB), that a PHP script may upload. * - The PHP loaders through which the system executes internal PHP scripts. * - Whether PHP protection is enabled on the server. * - Whether the user can search for the phpMyAdmin information schema. * - Whether the system restricts users from creating addon domains and subdomains outside of their directory. * - Whether the system requires passwords and other sensitive information use SSL encryption. Reset Password* feature is enabled for the account. Reset Password* feature is enabled for subaccounts on the account. Analog StatscPanel >> Home >> Metrics >> Analog Stats*). * - Whether the Apache Client Optimizer is enabled. * - Whether the AWStats software is enabled. * - Whether mailbox usage warnings are enabled. BoxTrapper* is enabled. * - Whether the system automatically suspends HTTP service for accounts that exceed their bandwidth limit. * - Whether Mailman mailing lists are enabled. * - Whether Roundcube webmail is enabled. * - Whether the Apache SpamAssassin™ spam filter is enabled. * - Whether Apache SpamAssassin's spam box feature is enabled. * - Whether the Webalizer statistics program is enabled. * - The default SSL/TLS encryption algorithm used by the system. * - Whether the system uses the MySQL® view. This view includes disk usage by all MySQL tables in the disk usage totals. * - Whether the system prefixes Mailman URLs with the prefix. For example, . * - Whether the Apache Tweak is enabled. * - The system's Linux® kernel version. * If you don't use this parameter, this function returns of the server's configuration settings. * To retrieve multiple variables, increment this parameter. For example, , , . Enum: "default_theme", "email_filter_storage_directory", "allow_park_subdomain_on_hostname", "allow_remote_domains", "allow_unregistered_domains", "apache_port", "apache_ssl_port", "api_shell", "awstats_browser_update", "awstats_reverse_dns", "cpanel_root_directory", "database_prefix_required", "display_cpanel_doclinks", "dnsadmin_app", "empty_trash_days", "enable_file_protect", "file_upload_maximum_bytes", "file_upload_must_leave_bytes", "file_usage", "ftp_server", "htaccess_check_recurse", "invite_sub", "ipv6_listen", "local_nameserver_type", "logout_redirect_url", "mailbox_storage_format", "mail_server", "minimum_password_strength", "minimum_password_strength_mysql", "mysql_host", "mysql_version", "php_maximum_execution_time", "php_post_maximum_size", "php_system_default_version", "php_upload_maximum_filesize", "php_loader", "php_open_basedir_home", "phpmyadmin_disable_search_info_schema", "docroots_in_public_html_only", "require_ssl", "allow_reset_password", "allow_reset_password_for_subaccounts", "disable_analog", "skip_apache_clients_optimizer", "disable_awstats", "skip_mailbox_warnings_check", "disable_boxtrapper", "skip_bandwidth_limit_check", "disable_mailman", "disable_roundcube", "disable_spamassassin", "disable_spambox", "disable_webalizer", "ssl_default_key_type", "use_information_schema", "use_mail_for_mailman_url", "is_mod_userdir_enabled", "version" ## Response 200 fields (application/json): - `apiversion` (integer) The version of the API. Example: 3 - `func` (string) The name of the method called. Example: "get_server_information" - `module` (string) The name of the module called. Example: "Variables" - `result` (object) - `result.data` (object) - `result.data.allow_park_subdomain_on_hostname` (integer,null) Whether the system allows users to park subdomains of the server's hostname. * - Allows. * - Doesn't allow. Enum: 1, 0 - `result.data.allow_remote_domains` (integer,null) Whether the system allows users to create addon domains or aliases that resolve to other servers. * - Allows. * - Doesn't allow. Enum: 1, 0 - `result.data.allow_reset_password` (integer,null) Whether cPanel's [](https://go.cpanel.net/resetsubaccountpass) feature is enabled for the account. Reset Password* feature enabled. Reset Password* feature not enabled. Enum: 1, 0 - `result.data.allow_reset_password_for_subaccounts` (integer,null) Whether cPanel's [](https://go.cpanel.net/resetsubaccountpass) feature is enabled for subaccounts on the account. Reset Password* feature enabled. Reset Password* feature not enabled. Enum: 1, 0 - `result.data.allow_unregistered_domains` (integer,null) Whether the system allows users to add domains they didn't register with a domain name registrar. * - Allows. * - Doesn't allow. Enum: 1, 0 - `result.data.apache_port` (string,null) The IP address or IP address with a firewall port number that Apache uses to listen for requests and serve web pages over an unsecured connection. Example: "192.0.2.0:80" - `result.data.apache_ssl_port` (string,null) The IP address or IP address with a firewall port number that Apache uses to listen for requests and serve web pages over a secure connection. Example: "192.0.2.0:443" - `result.data.api_shell` (integer,null) Whether the user can access cPanel's [](https://go.cpanel.net/cpaneldocsAPIShell) interface (). * - Can access. * - Can't access. Enum: 1, 0 - `result.data.awstats_browser_update` (integer,null) Whether the user can update their [AWStats](http://awstats.sourceforge.net/) software. * - Can update. * - Can't update. Enum: 1, 0 - `result.data.awstats_reverse_dns` (integer,null) Whether the AWStats statistical analysis software interprets visitors' domain names as IP addresses. * - Interprets visitors' domain names as IP addresses. * - Doesn't interpret visitors' domain names as IP addresses. Enum: 1, 0 - `result.data.cpanel_root_directory` (string,null) The cPanel directory. Example: "/usr/local/cpanel" - `result.data.database_prefix_required` (integer,null) Whether the account requires database prefixing. * - Requires database prefixing. * - Doesn't require database prefixing. Enum: 1, 0 - `result.data.default_theme` (string,null) The cPanel interface's default theme. Example: "jupiter" - `result.data.disable_analog` (integer,null) Whether users can access the [](https://go.cpanel.net/cpaneldocsAnalogStats) interface (). * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.disable_awstats` (integer,null) Whether the [AWStats](http://awstats.sourceforge.net/) software is enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.disable_boxtrapper` (integer,null) Whether [](https://go.cpanel.net/cpaneldocsBoxTrapper) is enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.disable_mailman` (integer,null) Whether Mailman mailing lists are enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.disable_roundcube` (integer,null) Whether [Roundcube webmail](https://roundcube.net/) is enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.disable_spamassassin` (integer,null) Whether the Apache SpamAssassin spam filter is enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.disable_spambox` (integer,null) Whether Apache SpamAssassin's spam box feature is enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.disable_webalizer` (integer,null) Whether the [Webalizer](http://www.webalizer.org/) statistics program is enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.display_cpanel_doclinks` (integer,null) Whether the system displays links to cPanel feature documentation in the cPanel interface. * - Displays documentation links. * - Doesn't display documentation links. Enum: 1, 0 - `result.data.dnsadmin_app` (string,null) The application that processes DNS management requests. * The value is an application's file path, relative to the user's home directory. * * Example: "dnsadmin" - `result.data.docroots_in_public_html_only` (integer,null) Whether the system restricts users from creating addon domains and subdomains outside of their directory. * - Restricts users from creating addon domains and subdomains outside of their directory. * - Allows users to creating addon domains and subdomains outside of their directory. Enum: 1, 0 - `result.data.email_filter_storage_directory` (string,null) The location of the Exim email filter storage directory. Example: "/etc/vfilters" - `result.data.empty_trash_days` (string,null) The minimum age of files that the system will automatically purge from folders in user home directories. Example: "disabled" - `result.data.enable_file_protect` (integer,null) Whether [EasyApache 4's option](https://go.cpanel.net/EasyApache4FileprotectOption) is enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.file_upload_maximum_bytes` (integer,null) The maximum file size, in megabytes (MB), that a user can upload to a server. - `result.data.file_upload_must_leave_bytes` (integer,null) The minimum filesystem quota that the system requires after a file uploads to a server. Example: 5 - `result.data.file_usage` (integer,null) Whether file usage information displays in the cPanel interface's statistics bar. * - Displays file usage information. * - Doesn't display file usage information. Enum: 1, 0 - `result.data.ftp_server` (string,null) The FTP server. * - The Pure-FTPD server. * - The ProFTPD FTP server. * - FTP has been disabled on this server. Enum: "pure-ftpd", "proftpd", "disabled" - `result.data.htaccess_check_recurse` (integer,null) The maximum number of directories deep to look for files when you change the PHP handler. Example: 2 - `result.data.invite_sub` (integer,null) Whether cPanel account users can send invitations to new Subaccount users via cPanel's [](https://go.cpanel.net/cpaneldocsUserManager) interface (). * - Can send invitations. * - Can't send invitations. Enum: 1, 0 - `result.data.ipv6_listen` (integer,null) Whether the daemon and other cPanel & WHM services listen on IPv6. * - Listen on IPv6. * - Don't listen on IPv6. Enum: 1, 0 - `result.data.is_mod_userdir_enabled` (integer,null) Whether the [Apache Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) is enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.local_nameserver_type` (string,null) The DNS nameserver's type. * - The PowerDNS nameserver. * - The bind nameserver. * - Nameserver's have been disabled on this server. Enum: "powerdns", "bind", "disabled" - `result.data.logout_redirect_url` (string,null) The logout redirection URL. Example: "https://cpanel.net" - `result.data.mail_server` (string,null) The mailserver type. * - The Dovecot mailserver. * - The mailserver is disabled on this system. Enum: "dovecot", "disabled" - `result.data.mailbox_storage_format` (string,null) The mailbox storage format for new accounts. * - The mdbox storage format. * - The maildir storage format. Enum: "mdbox", "maildir" - `result.data.minimum_password_strength` (integer,null) The minimum strength for cPanel account passwords. Example: 65 - `result.data.minimum_password_strength_mysql` (integer,null) The minimum strength for MySQL or MariaDB passwords. Example: 65 - `result.data.mysql_host` (string,null) The MySQL or MariaDB hostname or IP address. Example: "localhost" - `result.data.mysql_version` (string,null) The MySQL or MariaDB version. Example: "5.7" - `result.data.php_loader` (string,null) The PHP loaders through which the system executes internal PHP scripts. * - The ionCube PHP loader. * - The SourceGuardian PHP loader. * - Both the ionCube and SourceGuardian PHP loaders are in use. * An emtpy string - PHP loader is not in use. Enum: "", "ioncube", "sourceguardian", "ioncube,sourceguardian" - `result.data.php_maximum_execution_time` (integer,null) The number of seconds that a PHP script can run before the system terminates it. Example: 90 - `result.data.php_open_basedir_home` (integer,null) Whether PHP protection is enabled on the server. * - Enabled. * - Not enabled. We removed WHM's interface () Enum: 1, 0 - `result.data.php_post_maximum_size` (integer,null) The maximum size, in megabytes (MB), of a POST request. Example: 55 - `result.data.php_system_default_version` (string,null) The system's default version of PHP. Example: "ea-php73" - `result.data.php_upload_maximum_filesize` (integer,null) The maximum file size, in megabytes (MB), that a PHP script may upload. Example: 50 - `result.data.phpmyadmin_disable_search_info_schema` (integer,null) Whether the user can search for the phpMyAdmin information schema. * - Searches are enabled. * - Searches are enabled. Enum: 1, 0 - `result.data.require_ssl` (integer,null) Whether the system requires passwords and other sensitive information use SSL encryption. * - Requires SSL. * - Doesn't require SSL. Enum: 1, 0 - `result.data.skip_apache_clients_optimizer` (integer,null) Whether the Apache Client Optimizer is enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.skip_bandwidth_limit_check` (integer,null) Whether the system automatically suspends HTTP service for accounts that exceed their bandwidth limit. * - Suspends HTTP service. * - Doesn't suspend HTTP service. Enum: 1, 0 - `result.data.skip_mailbox_warnings_check` (integer,null) Whether mailbox usage warnings are enabled. * - Enabled. * - Not enabled. Enum: 1, 0 - `result.data.ssl_default_key_type` (string,null) The default SSL/TLS encryption algorithm used by the system. * - The rsa-2048 encryption algorithm. * - The ecdsa-secp384r1 encryption algorithm. * - The ecdsa-prime256v1 encryption algorithm. * - The rsa-4096 encryption algorithm. Enum: "rsa-2048", "ecdsa-secp384r1", "ecdsa-prime256v1", "rsa-4096" - `result.data.use_information_schema` (integer,null) Whether the system uses the MySQL view. This view includes disk usage by all MySQL tables in the disk usage totals. * - Uses MySQL's view. * - Doesn't use MySQL's view. Enum: 1, 0 - `result.data.use_mail_for_mailman_url` (integer,null) Whether the system prefixes Mailman URLs with mail. For example, . * - Prefixes Mailman URLs with the prefix. * - Doesn't prefix Mailman URLs with the prefix. Enum: 1, 0 - `result.data.version` (string,null) The system's Linux Kernel version. Example: "3.4" - `result.errors` (array,null) List of errors if the API failed. - `result.messages` (array,null) List of messages generated by the API. - `result.metadata` (object) - `result.status` (integer) - 1 - Success - 0 - Failed: Check the errors field for more details. Enum: 0, 1 - `result.warnings` (array,null) List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.