# 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.136.0.22
Security: BasicAuth

## Query parameters:

  - `name` (string)
    The server configuration settings to return.


Click to view information about the available server configuration settings.

* default_theme - The cPanel interface's default theme.
* email_filter_storage_directory - The location of the Exim email filter storage directory.
* allow_park_subdomain_on_hostname - Whether the system allows users to park subdomains of the server's hostname.
* allow_remote_domains - Whether the system allows users to create addon domains or aliases that resolve to other servers.
* allow_unregistered_domains - Whether the system allows users to add domains they didn't register with a domain name registrar.
* apache_port - 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.
* apache_ssl_port - The port or IP address that Apache uses to listen for requests and serve web pages over a secure connection.
 api_shell - Whether the user can access cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell*).
* awstats_browser_update - Whether the user can update their AWStats software.
* awstats_reverse_dns - Whether the AWStats statistical analysis software interprets visitors' domain names as IP addresses.
* cpanel_root_directory - The cPanel root directory.
* database_prefix_required - Whether the account requires database prefixing.
* display_cpanel_doclinks - Whether the system displays links to cPanel feature documentation in the cPanel interface.
* dnsadmin_app - The application that processes DNS management requests.
* empty_trash_days - The minimum age of files that the system will automatically purge from .trash folders in user home directories.
 enable_file_protect - Whether EasyApache 4's FileProtect* option is enabled.
* file_upload_maximum_bytes - The maximum file size, in megabytes (MB), that a user can upload to a server.
* file_upload_must_leave_bytes - The minimum filesystem quota that the system requires after a file uploads to a server.
 file_usage - Whether file usage information displays in the cPanel Home* interface's statistics bar.
* ftp_server - The FTP server.
* htaccess_check_recurse - The maximum number of directories deep to look for .htaccess files when you change the PHP handler.
 invite_sub - Whether cPanel account users can send invitations to new Subaccount users via cPanel's User Manager interface (cPanel >> Home >> Preferences >> User Manager*).
* ipv6_listen - Whether the cpsrvd daemon and other cPanel & WHM services listen on IPv6.
* local_nameserver_type - The DNS nameserver's type.
* logout_redirect_url - The logout redirection URL.
* mailbox_storage_format - The mailbox storage format for new accounts.
* mail_server - The mailserver type.
* minimum_password_strength - The minimum strength for cPanel account passwords. 
* minimum_password_strength_mysql - The minimum strength for MySQL® or MariaDB® passwords.
* mysql_host - The MySQL or MariaDB hostname or IP address.
* mysql_version - The MySQL or MariaDB version.
* php_maximum_execution_time - The number of seconds that a PHP script can run before the system terminates it.
* php_post_maximum_size - The maximum size, in megabytes (MB), of a POST request.
* php_system_default_version - The system's default version of PHP.
* php_upload_maximum_filesize - The maximum file size, in megabytes (MB), that a PHP script may upload.
* php_loader - The PHP loaders through which the system executes internal PHP scripts.
* php_open_basedir_home - Whether PHP open_basedir protection is enabled on the server.
* phpmyadmin_disable_search_info_schema - Whether the user can search for the phpMyAdmin information schema.
* docroots_in_public_html_only - Whether the system restricts users from creating addon domains and subdomains outside of their public_html directory.
* require_ssl - Whether the system requires passwords and other sensitive information use SSL encryption.
 allow_reset_password - Whether cPanel's Reset Password* feature is enabled for the account.
 allow_reset_password_for_subaccounts - Whether cPanel's Reset Password* feature is enabled for subaccounts on the account.
 disable_analog - Whether users can access the Analog Stats interface (cPanel >> Home >> Metrics >> Analog Stats*).
* skip_apache_clients_optimizer - Whether the Apache Client Optimizer is enabled.
* disable_awstats - Whether the AWStats software is enabled.
* skip_mailbox_warnings_check - Whether mailbox usage warnings are enabled.
 disable_boxtrapper - Whether BoxTrapper* is enabled.
* skip_bandwidth_limit_check - Whether the system automatically suspends HTTP service for accounts that exceed their bandwidth limit.
* disable_mailman - Whether Mailman mailing lists are enabled.
* disable_roundcube - Whether Roundcube webmail is enabled.
* disable_spamassassin - Whether the Apache SpamAssassin™ spam filter is enabled.
* disable_spambox - Whether Apache SpamAssassin's spam box feature is enabled.
* disable_webalizer - Whether the Webalizer statistics program is enabled.
* ssl_default_key_type - The default SSL/TLS encryption algorithm used by the system.
* use_information_schema - Whether the system uses the MySQL® INFORMATION_SCHEMA view. This view includes disk usage by all MySQL tables in the disk usage totals.
* use_mail_for_mailman_url - Whether the system prefixes Mailman URLs with the mail prefix. For example, http://mail.domain.com/mailman.
* is_mod_userdir_enabled - Whether the Apache mod_userdir Tweak is enabled.
* version - The system's Linux® kernel version.


Note:

* If you don't use this parameter, this function returns all of the server's configuration settings.
* To retrieve multiple variables, increment this parameter. For example, name-1=variable, name-2=variable, name-3=variable.
    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.

* 1 - Allows.
* 0 - 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.

* 1 - Allows.
* 0 - Doesn't allow.
    Enum: 1, 0

  - `result.data.allow_reset_password` (integer,null)
    Whether cPanel's [Reset Password](https://go.cpanel.net/resetsubaccountpass) feature is enabled for the account.

 1 - Reset Password* feature enabled.
 0 - Reset Password* feature not enabled.
    Enum: 1, 0

  - `result.data.allow_reset_password_for_subaccounts` (integer,null)
    Whether cPanel's [Reset Password](https://go.cpanel.net/resetsubaccountpass) feature is enabled for subaccounts on the account.

 1 - Reset Password* feature enabled.
 0 - 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.

* 1 - Allows.
* 0 - 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 [API Shell](https://go.cpanel.net/cpaneldocsAPIShell) interface (cPanel >> Home >> Advanced >> API Shell).

* 1 - Can access.
* 0 - 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.

* 1 - Can update.
* 0 - 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.

* 1 - Interprets visitors' domain names as IP addresses.
* 0 - Doesn't interpret visitors' domain names as IP addresses.
    Enum: 1, 0

  - `result.data.cpanel_root_directory` (string,null)
    The cPanel root directory.
    Example: "/usr/local/cpanel"

  - `result.data.database_prefix_required` (integer,null)
    Whether the account requires database prefixing.

* 1 - Requires database prefixing.
* 0 - 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 [Analog Stats](https://go.cpanel.net/cpaneldocsAnalogStats) interface (cPanel >> Home >> Metrics >> Analog Stats).

* 1 - Enabled.
* 0 - Not enabled.
    Enum: 1, 0

  - `result.data.disable_awstats` (integer,null)
    Whether the [AWStats](http://awstats.sourceforge.net/) software is enabled.

* 1 - Enabled.
* 0 - Not enabled.
    Enum: 1, 0

  - `result.data.disable_boxtrapper` (integer,null)
    Whether [BoxTrapper](https://go.cpanel.net/cpaneldocsBoxTrapper) is enabled.

* 1 - Enabled.
* 0 - Not enabled.
    Enum: 1, 0

  - `result.data.disable_mailman` (integer,null)
    Whether Mailman mailing lists are enabled.

* 1 - Enabled.
* 0 - Not enabled.
    Enum: 1, 0

  - `result.data.disable_roundcube` (integer,null)
    Whether [Roundcube webmail](https://roundcube.net/) is enabled.

* 1 - Enabled.
* 0 - Not enabled.
    Enum: 1, 0

  - `result.data.disable_spamassassin` (integer,null)
    Whether the Apache SpamAssassin spam filter is enabled.

* 1 - Enabled.
* 0 - Not enabled.
    Enum: 1, 0

  - `result.data.disable_spambox` (integer,null)
    Whether Apache SpamAssassin's spam box feature is enabled.

* 1 - Enabled.
* 0 - Not enabled.
    Enum: 1, 0

  - `result.data.disable_webalizer` (integer,null)
    Whether the [Webalizer](http://www.webalizer.org/) statistics program is enabled.

* 1 - Enabled.
* 0 - 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.

* 1 - Displays documentation links.
* 0 - 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.
* dnsadmin
* auto-detect SSL
    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 public_html directory.

* 1 - Restricts users from creating addon domains and subdomains outside of their public_html directory.
* 0 - Allows users to creating addon domains and subdomains outside of their public_html 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 .trash folders in user home directories.
    Example: "disabled"

  - `result.data.enable_file_protect` (integer,null)
    Whether [EasyApache 4's FileProtect option](https://go.cpanel.net/EasyApache4FileprotectOption) is enabled.

* 1 - Enabled.
* 0 - 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 Home interface's statistics bar.

* 1 - Displays file usage information.
* 0 - Doesn't display file usage information.
    Enum: 1, 0

  - `result.data.ftp_server` (string,null)
    The FTP server.

* pure-ftpd - The Pure-FTPD server.
* proftpd - The ProFTPD FTP server.
* disabled - 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 .htaccess 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 [User Manager](https://go.cpanel.net/cpaneldocsUserManager) interface (cPanel >> Home >> Preferences >> User Manager).

* 1 - Can send invitations.
* 0 - Can't send invitations.
    Enum: 1, 0

  - `result.data.ipv6_listen` (integer,null)
    Whether the cpsrvd daemon and other cPanel & WHM services listen on IPv6.

* 1 - Listen on IPv6.
* 0 - Don't listen on IPv6.
    Enum: 1, 0

  - `result.data.is_mod_userdir_enabled` (integer,null)
    Whether the [Apache mod_userdir Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) is enabled.

* 1 - Enabled.
* 0 - Not enabled.
    Enum: 1, 0

  - `result.data.local_nameserver_type` (string,null)
    The DNS nameserver's type.

* powerdns - The PowerDNS nameserver.
* bind - The bind nameserver.
* disabled - 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.

* dovecot - The Dovecot mailserver.
* disabled - The mailserver is disabled on this system.
    Enum: "dovecot", "disabled"

  - `result.data.mailbox_storage_format` (string,null)
    The mailbox storage format for new accounts.

* mdbox - The mdbox storage format.
* maildir - 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.

* ioncube - The ionCube PHP loader.
* sourceguardian - The SourceGuardian PHP loader.
* ioncube,sourceguardian - 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 open_basedir protection is enabled on the server.

* 1 - Enabled.
* 0 - Not enabled.

Important:

We removed WHM's PHP open_basedir Tweak interface (WHM >> Home >> Security Center >> PHP open_basedir Tweak)
    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.

* 1 - Searches are enabled.
* 0 - Searches are not enabled.
    Enum: 1, 0

  - `result.data.require_ssl` (integer,null)
    Whether the system requires passwords and other sensitive information use SSL encryption.

* 1 - Requires SSL.
* 0 - Doesn't require SSL.
    Enum: 1, 0

  - `result.data.skip_apache_clients_optimizer` (integer,null)
    Whether the Apache Client Optimizer is enabled.

* 1 - Enabled.
* 0 - 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.

* 1 - Suspends HTTP service.
* 0 - Doesn't suspend HTTP service.
    Enum: 1, 0

  - `result.data.skip_mailbox_warnings_check` (integer,null)
    Whether mailbox usage warnings are enabled.

* 1 - Enabled.
* 0 - Not enabled.
    Enum: 1, 0

  - `result.data.ssl_default_key_type` (string,null)
    The default SSL/TLS encryption algorithm used by the system.

* rsa-2048 - The rsa-2048 encryption algorithm.
* ecdsa-secp384r1 - The ecdsa-secp384r1 encryption algorithm.
* ecdsa-prime256v1 - The ecdsa-prime256v1 encryption algorithm.
* rsa-4096 - 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 INFORMATION_SCHEMA view. This view includes disk usage by all MySQL tables in the disk usage totals.

* 1 - Uses MySQL's INFORMATION_SCHEMA view.
* 0 - Doesn't use MySQL's INFORMATION_SCHEMA view.
    Enum: 1, 0

  - `result.data.use_mail_for_mailman_url` (integer,null)
    Whether the system prefixes Mailman URLs with mail. For example, http://mail.domain.com/mailman.

* 1 - Prefixes Mailman URLs with the mail. prefix.
* 0 - Doesn't prefix Mailman URLs with the mail. 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.