---
title: "Return server's configuration settings"
method: GET
path: "/Variables/get_server_information"
tags: ["cPanel Server Information", "Variables"]
---

# Return server's configuration settings

`GET /Variables/get_server_information`

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.

## Query parameters

- `name` '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`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `allow_park_subdomain_on_hostname` 1 | 0, nullable — Whether the system allows users to park subdomains of the server's hostname. * `1` - Allows. * `0` - Doesn't allow.
      - `allow_remote_domains` 1 | 0, nullable — Whether the system allows users to create addon domains or aliases that resolve to other servers. * `1` - Allows. * `0` - Doesn't allow.
      - `allow_reset_password` 1 | 0, nullable — 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.
      - `allow_reset_password_for_subaccounts` 1 | 0, nullable — 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.
      - `allow_unregistered_domains` 1 | 0, nullable — Whether the system allows users to add domains they didn't register with a domain name registrar. * `1` - Allows. * `0` - Doesn't allow.
      - `apache_port` string, nullable — 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` string, nullable — 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.
      - `api_shell` 1 | 0, nullable — 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.
      - `awstats_browser_update` 1 | 0, nullable — Whether the user can update their [AWStats](http://awstats.sourceforge.net/) software. * `1` - Can update. * `0` - Can't update.
      - `awstats_reverse_dns` 1 | 0, nullable — 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.
      - `cpanel_root_directory` string, path, nullable — The cPanel `root` directory.
      - `database_prefix_required` 1 | 0, nullable — Whether the account requires database prefixing. * `1` - Requires database prefixing. * `0` - Doesn't require database prefixing.
      - `default_theme` string, nullable — The cPanel interface's default theme.
      - `disable_analog` 1 | 0, nullable — Whether users can access the [*Analog Stats*](https://go.cpanel.net/cpaneldocsAnalogStats) interface (*cPanel >> Home >> Metrics >> Analog Stats*). * `1` - Enabled. * `0` - Not enabled.
      - `disable_awstats` 1 | 0, nullable — Whether the [AWStats](http://awstats.sourceforge.net/) software is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `disable_boxtrapper` 1 | 0, nullable — Whether [*BoxTrapper*](https://go.cpanel.net/cpaneldocsBoxTrapper) is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `disable_mailman` 1 | 0, nullable — Whether Mailman mailing lists are enabled. * `1` - Enabled. * `0` - Not enabled.
      - `disable_roundcube` 1 | 0, nullable — Whether [Roundcube webmail](https://roundcube.net/) is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `disable_spamassassin` 1 | 0, nullable — Whether the Apache SpamAssassin spam filter is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `disable_spambox` 1 | 0, nullable — Whether Apache SpamAssassin's spam box feature is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `disable_webalizer` 1 | 0, nullable — Whether the [Webalizer](http://www.webalizer.org/) statistics program is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `display_cpanel_doclinks` 1 | 0, nullable — Whether the system displays links to cPanel feature documentation in the cPanel interface. * `1` - Displays documentation links. * `0` - Doesn't display documentation links.
      - `dnsadmin_app` union — 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`
        - string — The application's file path, relative to the user's home directory.
        - 'dnsadmin' | 'auto-detect SSL'
      - `docroots_in_public_html_only` 1 | 0, nullable — 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.
      - `email_filter_storage_directory` string, path, nullable — The location of the Exim email filter storage directory.
      - `empty_trash_days` string, nullable — The minimum age of files that the system will automatically purge from `.trash` folders in user home directories.
      - `enable_file_protect` 1 | 0, nullable — Whether [EasyApache 4's *FileProtect* option](https://go.cpanel.net/EasyApache4FileprotectOption) is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `file_upload_maximum_bytes` integer, nullable — The maximum file size, in megabytes (MB), that a user can upload to a server.
      - `file_upload_must_leave_bytes` integer, nullable — The minimum filesystem quota that the system requires after a file uploads to a server.
      - `file_usage` 1 | 0, nullable — 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.
      - `ftp_server` 'pure-ftpd' | 'proftpd' | 'disabled', nullable — The FTP server. * `pure-ftpd` - The Pure-FTPD server. * `proftpd` - The ProFTPD FTP server. * `disabled` - FTP has been disabled on this server.
      - `htaccess_check_recurse` integer, nullable — The maximum number of directories deep to look for `.htaccess` files when you change the PHP handler.
      - `invite_sub` 1 | 0, nullable — 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.
      - `ipv6_listen` 1 | 0, nullable — Whether the `cpsrvd` daemon and other cPanel & WHM services listen on IPv6. * `1` - Listen on IPv6. * `0` - Don't listen on IPv6.
      - `is_mod_userdir_enabled` 1 | 0, nullable — Whether the [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `local_nameserver_type` 'powerdns' | 'bind' | 'disabled', nullable — The DNS nameserver's type. * `powerdns` - The PowerDNS nameserver. * `bind` - The bind nameserver. * `disabled` - Nameserver's have been disabled on this server.
      - `logout_redirect_url` string, url, nullable — The logout redirection URL.
      - `mail_server` 'dovecot' | 'disabled', nullable — The mailserver type. * `dovecot` - The Dovecot mailserver. * `disabled` - The mailserver is disabled on this system.
      - `mailbox_storage_format` 'mdbox' | 'maildir', nullable — The mailbox storage format for new accounts. * `mdbox` - The mdbox storage format. * `maildir` - The maildir storage format.
      - `minimum_password_strength` integer, nullable — The minimum strength for cPanel account passwords.
      - `minimum_password_strength_mysql` integer, nullable — The minimum strength for MySQL or MariaDB passwords.
      - `mysql_host` union — The MySQL or MariaDB hostname or IP address.
        - string, domain
        - string, ipv4
      - `mysql_version` string, nullable — The MySQL or MariaDB version.
      - `php_loader` '' | 'ioncube' | 'sourceguardian' | 'ioncube,sourceguardian', nullable — 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.
      - `php_maximum_execution_time` integer, nullable — The number of seconds that a PHP script can run before the system terminates it.
      - `php_open_basedir_home` 1 | 0, nullable — 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*)
      - `php_post_maximum_size` integer, nullable — The maximum size, in megabytes (MB), of a POST request.
      - `php_system_default_version` string, nullable — The system's default version of PHP.
      - `php_upload_maximum_filesize` integer, nullable — The maximum file size, in megabytes (MB), that a PHP script may upload.
      - `phpmyadmin_disable_search_info_schema` 1 | 0, nullable — Whether the user can search for the phpMyAdmin information schema. * `1` - Searches are enabled. * `0` - Searches are **not** enabled.
      - `require_ssl` 1 | 0, nullable — Whether the system requires passwords and other sensitive information use SSL encryption. * `1` - Requires SSL. * `0` - Doesn't require SSL.
      - `skip_apache_clients_optimizer` 1 | 0, nullable — Whether the Apache Client Optimizer is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `skip_bandwidth_limit_check` 1 | 0, nullable — Whether the system automatically suspends HTTP service for accounts that exceed their bandwidth limit. * `1` - Suspends HTTP service. * `0` - Doesn't suspend HTTP service.
      - `skip_mailbox_warnings_check` 1 | 0, nullable — Whether mailbox usage warnings are enabled. * `1` - Enabled. * `0` - Not enabled.
      - `ssl_default_key_type` 'rsa-2048' | 'ecdsa-secp384r1' | 'ecdsa-prime256v1' | 'rsa-4096', nullable — 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.
      - `use_information_schema` 1 | 0, nullable — 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.
      - `use_mail_for_mailman_url` 1 | 0, nullable — 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.
      - `version` string, nullable — The system's Linux Kernel version.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — - 1 - Success - 0 - Failed: Check the errors field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)