---
title: "Return cPanel account's configuration settings"
method: GET
path: "/Variables/get_user_information"
tags: ["Variables", "Account Information"]
---

# Return cPanel account's configuration settings

`GET /Variables/get_user_information`

This function retrieves the user's account configuration settings.

## Query parameters

- `name` string

## 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
      - `backup_enabled` 0 | 1 — Whether the user has backups enabled. * `1` - Backups enabled. * `0` - Backups not enabled.
      - `bandwidth_limit` integer — The account's bandwidth limit. * `0` - unlimited * A maximum amount of bandwidth, in bytes.
      - `cgi_enabled` 0 | 1 — Whether CGI is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `contact_email` string, email — The account's contact email address.
      - `contact_email_2` string, email — The account's alternate contact email address, if one exists.
      - `cpanel_root_directory` string, path — The `root` directory.
      - `created` integer — The account's creation date in [Unix time](http://en.wikipedia.org/wiki/Unix_time) format.
      - `created_in_version` string, cPanel version — The version of cPanel used during account creation.
      - `database_owner` string, username — The owner of the account's databases. * `root` * A reseller account's username. * The account's username.
      - `dead_domains` string[] — The account's inactive domains.
      - `demo_mode` 0 | 1 — Whether demo mode is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `disk_block_limit` integer — The number of disk blocks for the account. * `0` - unlimited * A maximum amount of disk blocks, in kilobytes.
      - `dkim_enabled` 0 | 1 — Whether DomainKeys Identified Mail (DKIM) is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `domain` string, domain — The account's main domain.
      - `domains` string[] — list of the account's domains and subdomains.
      - `feature` object — The available features on the account that exist in the `/var/cpanel/users/user` file`, where user represents the cPanel user. **Note:** This object returns any custom features that the hosting provider adds to the `/var/cpanel/users/user` file.
        - `additionalProperties` 0 | 1 — Whether the feature is enabled. * `1` - Enabled. * `0` - Disabled. **Note:** The feature's name is the return name.
      - `feature_list` string — The account's [feature list](https://go.cpanel.net/whmdocs84FeatureManager) name.
      - `gid` integer — The account's group ID.
      - `home` string, path — The user's home directory.
      - `home_directory_links` string[] — Any symlinks to the cPanel account's home directory. An array of one or more home directory symlinks.
      - `ip` string, ipv4 — The account's IPv4 address.
      - `lang` string — The account's language.
      - `last_modified` integer — The most recent modification time of the `/var/cpanel/users/user` file in [Unix time format](https://en.wikipedia.org/wiki/Unix_time). **Note:** `user` represents the cPanel user.
      - `legacy_backup_enabled` 0 | 1 — Whether legacy backups are enabled. * `1` - Enabled. * `0` - Disabled.
      - `locale` string, ISO-3166-1 (alpha-2) — The account's default locale, a two-letter [ISO-3166 code](http://www.iso.org/iso/country_codes.htm).
      - `mailbox_format` 'maildir' | 'mbox' — The storage format that the account's mailboxes use. * `maildir` * `mbox`
      - `maximum_addon_domains` union — The account's maximum number of addon domains. * `unlimited` * An integer that represents a number of addon domains.
        - 'unlimited'
        - integer
      - `maximum_databases` union — The account's maximum number of SQL databases. * `unlimited` * An integer that represents a number of SQL databases.
        - 'unlimited'
        - integer
      - `maximum_defer_fail_percentage` union — The [percentage of failed or deferred email messages](https://go.cpanel.net/howtopreventspam) that the account can send per hour before outgoing mail is rate-limited. * `unlimited` * An integer value.
        - 'unlimited'
        - integer
      - `maximum_email_account_disk_quota` union — The maximum size, that the account can define when it creates an email account. * `unlimited` * An integer value, in Megabytes (MB).
        - 'unlimited'
        - integer
      - `maximum_emails_per_hour` union — The maximum number of emails that the account can send in one hour. * A positive integer. * `0` or `unlimited` - The account can send an unlimited number of emails.
        - 'unlimited'
        - integer
      - `maximum_ftp_accounts` union — The account's maximum number of FTP accounts. * `unlimited` * An integer that represents a number of FTP accounts.
        - 'unlimited'
        - integer
      - `maximum_mail_accounts` union — The maximum number of email accounts for the account. * `unlimited` * An integer that represents a number of email accounts.
        - 'unlimited'
        - integer
      - `maximum_mailing_lists` union — The account's maximum number of mailing lists. * `unlimited` * An integer that represents a number of mailing lists.
        - 'unlimited'
        - integer
      - `maximum_parked_domains` union — The account's maximum number of aliases. * `unlimited` * An integer that represents a number of aliases.
        - 'unlimited'
        - integer
      - `maximum_passenger_apps` union — The account's maximum number of Ruby applications. * `unlimited` * An integer that represents a number of applications.
        - 'unlimited'
        - integer
      - `maximum_subdomains` union — The account's maximum number of subdomains. * `unlimited` * An integer that represents a number of subdomains.
        - 'unlimited'
        - integer
      - `mxcheck` object — Domains and their mail exchanger (MX) type.
        - `additionalProperties` 'local' | 'remote' | 'secondary' — The domain's MX type. * `local` - Accept mail locally for the domain. * `remote` - Do not accept mail locally for the domain. * `secondary` - Accept mail until a higher priority mail server is available. **Note:** The return's name is the domain name.
      - `notify_account_authn_link` 0 | 1 — Whether the systems sends a notification when someone links the account to an external authentication account. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_account_authn_link_notification_disabled` 0 | 1 — Whether the systems sends a notification when someone disables notifications for external authentication account links. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_account_login` 0 | 1 — Whether the system sends a notification when someone logs in to the account. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_account_login_for_known_netblock` 0 | 1 — Whether the system sends a notification when a user on a known netblock logs in to the account. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_account_login_notification_disabled` 0 | 1 — Whether the system sends a notification when someone disables notifications for account logins. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_autossl_expiry` 0 | 1 — Whether the system sends a notification when an AutoSSL certificate expires. * `1` - Notifies. * `0` - Doesn't notify
      - `notify_autossl_expiry_coverage` 0 | 1 — Whether the system sends a notification when AutoSSL cannot renew a certificate because domains that fail Domain Control Validation (DCV) exist on the current certificate. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_autossl_renewal_coverage` 0 | 1 — Whether the system sends a notification when AutoSSL renews a certificate. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_autossl_renewal_coverage_reduced` 0 | 1 — Whether the system sends a notification when AutoSSL renews a certificate, but the new certificate lacks at least one domain that the previous certificate secured. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_autossl_renewal_uncovered_domains` 0 | 1 — Whether the system sends a notification when AutoSSL renews a certificate, but the new certificate lacks at least one domain that the previous certificate secured. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_bandwidth_limit` 0 | 1 — Whether the systems sends a notification when the account reaches its bandwidth quota. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_contact_address_change` 0 | 1 — Whether the systems sends a notification when someone changes the contact address for the account. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_contact_address_change_notification_disabled` 0 | 1 — Whether the systems sends a notification when someone disables the notification for contact address changes. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_disk_limit` 0 | 1 — Whether the systems sends a notification when the account reaches its disk usage limit. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_password_change` 0 | 1 — Whether the systems sends a notification when someone changes the account's password. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_password_change_notification_disabled` 0 | 1 — Whether the systems sends a notification when someone disables notifications for password changes. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_ssl_expiry` 0 | 1 — Whether the systems sends a notification when an SSL certificate on the account expires. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_twofactorauth_change` 0 | 1 — Whether the systems sends a notification when the account's Two-Factor Authentication (2FA) credentials change. * `1` - Notifies. * `0` - Doesn't notify.
      - `notify_twofactorauth_change_notification_disabled` 0 | 1 — Whether the systems sends a notification when someone disables notifications for 2FA. * `1` - Notifies. * `0` - Doesn't notify.
      - `owner` string, username — The account's owner. * `root` * A reseller account's username. * The account's username.
      - `package_extensions` string[] — The account's package extensions.
      - `plan` string — The account's hosting package.
      - `pushbullet_access_token` string — The account's Pushbullet access token.
      - `shell` string, path — The account's shell.
      - `spf_enabled` 0 | 1 — Whether Sender Policy Framework (SPF) is enabled. * `1` - Enabled. * `0` - Not enabled.
      - `ssl_default_key_type` 'system' | 'rsa-2048' | 'rsa-4096' | 'ecdsa-prime256v1' | 'ecdsa-secp384r1' — The type of key to generate for the user’s TLS certificates and CSRs. * `system` — The system’s `ssl_default_key_type` value in the [`cpanel.config` file](https://go.cpanel.net/ThecpanelconfigFile). * `rsa-2048` — 2,048-bit RSA. * `rsa-4096` — 4,096-bit RSA. * `ecdsa-prime256v1` — ECDSA prime256v1 (“P-256”). * `ecdsa-secp384r1` — ECDSA secp384r1 (“P-384”).
      - `theme` string — The account's current theme.
      - `uid` integer — The account's user ID on the system.
      - `user` string — An existing account's username.
      - `utf8_mailbox` 0 | 1 — Whether UTF-8-encoded mailbox names are enabled for the cPanel account. * `1` - Enabled. * `0` - Not enabled.
    - `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)