# Return cPanel account's configuration settings

This function retrieves the user's account configuration settings.

Endpoint: GET /Variables/get_user_information
Version: 11.136.0.19
Security: BasicAuth

## Query parameters:

  - `name` (string)
    The user configuration variables to retrieve. If you don't use this parameter, this function returns all of the user's configuration data.

Note:

To retrieve multiple account configuration settings for a user, increment the parameter name. For example: name-0, name-1, and name-2.
    Example: "domain"

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "get_user_information"

  - `module` (string)
    The name of the module called.
    Example: "Variables"

  - `result` (object)

  - `result.data` (object)

  - `result.data.backup_enabled` (integer)
    Whether the user has backups enabled.
* 1 - Backups enabled.
* 0 - Backups not enabled.
    Enum: 0, 1

  - `result.data.bandwidth_limit` (integer)
    The account's bandwidth limit.
* 0 - unlimited
* A maximum amount of bandwidth, in bytes.

  - `result.data.cgi_enabled` (integer)
    Whether CGI is enabled.
* 1 - Enabled.
* 0 - Not enabled.
    Enum: 0, 1

  - `result.data.contact_email` (string)
    The account's contact email address.
    Example: "user@example.com"

  - `result.data.contact_email_2` (string)
    The account's alternate contact email address, if one exists.
    Example: "user2@example.com"

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

  - `result.data.created` (integer)
    The account's creation date in [Unix time](http://en.wikipedia.org/wiki/Unix_time) format.
    Example: 1432220941

  - `result.data.created_in_version` (string)
    The version of cPanel used during account creation.
    Example: "11.94.0.0"

  - `result.data.database_owner` (string)
    The owner of the account's databases.
* root
* A reseller account's username.
* The account's username.
    Example: "root"

  - `result.data.dead_domains` (array)
    The account's inactive domains.
    Example: ["example.example.com"]

  - `result.data.demo_mode` (integer)
    Whether demo mode is enabled.
* 1 - Enabled.
* 0 - Not enabled.
    Enum: 0, 1

  - `result.data.disk_block_limit` (integer)
    The number of disk blocks for the account.
* 0 - unlimited
* A maximum amount of disk blocks, in kilobytes.
    Example: 100000000

  - `result.data.dkim_enabled` (integer)
    Whether DomainKeys Identified Mail (DKIM) is enabled.
* 1 - Enabled.
* 0 - Not enabled.
    Enum: 0, 1

  - `result.data.domain` (string)
    The account's main domain.
    Example: "example.com"

  - `result.data.domains` (array)
    list of the account's domains and subdomains.
    Example: ["example.com"]

  - `result.data.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.
    Example: {"custom_feature":1}

  - `result.data.feature.additionalProperties` (integer)
    Whether the feature is enabled.
* 1 - Enabled.
* 0 - Disabled.

Note:

The feature's name is the return name.
    Enum: 0, 1

  - `result.data.feature_list` (string)
    The account's [feature list](https://go.cpanel.net/whmdocs84FeatureManager) name.
    Example: "feature_list"

  - `result.data.gid` (integer)
    The account's group ID.
    Example: 5678

  - `result.data.home` (string)
    The user's home directory.
    Example: "/home/user"

  - `result.data.home_directory_links` (array)
    Any symlinks to the cPanel account's home directory. An array of one or more home directory symlinks.
    Example: ["symlink"]

  - `result.data.ip` (string)
    The account's IPv4 address.
    Example: "192.0.2.0"

  - `result.data.lang` (string)
    The account's language.
    Example: "english"

  - `result.data.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.
    Example: 1416586493

  - `result.data.legacy_backup_enabled` (integer)
    Whether legacy backups are enabled.
* 1 - Enabled.
* 0 - Disabled.
    Enum: 0, 1

  - `result.data.locale` (string)
    The account's default locale, a two-letter [ISO-3166 code](http://www.iso.org/iso/country_codes.htm).
    Example: "en"

  - `result.data.mailbox_format` (string)
    The storage format that the account's mailboxes use.
* maildir
* mbox
    Enum: "maildir", "mbox"

  - `result.data.maximum_addon_domains` (any)
    The account's maximum number of addon domains.
* unlimited
* An integer that represents a number of addon domains.
    Example: "unlimited"

  - `result.data.maximum_databases` (any)
    The account's maximum number of SQL databases.
* unlimited
* An integer that represents a number of SQL databases.
    Example: "unlimited"

  - `result.data.maximum_defer_fail_percentage` (any)
    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.
    Example: "unlimited"

  - `result.data.maximum_email_account_disk_quota` (any)
    The maximum size, that the account can define when it creates an email account.
* unlimited
* An integer value, in Megabytes (MB).
    Example: "unlimited"

  - `result.data.maximum_emails_per_hour` (any)
    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.
    Example: "unlimited"

  - `result.data.maximum_ftp_accounts` (any)
    The account's maximum number of FTP accounts.
* unlimited
* An integer that represents a number of FTP accounts.
    Example: "unlimited"

  - `result.data.maximum_mail_accounts` (any)
    The maximum number of email accounts for the account.
* unlimited
* An integer that represents a number of email accounts.
    Example: "0"

  - `result.data.maximum_mailing_lists` (any)
    The account's maximum number of mailing lists.
* unlimited
* An integer that represents a number of mailing lists.
    Example: "unlimited"

  - `result.data.maximum_parked_domains` (any)
    The account's maximum number of aliases.
* unlimited
* An integer that represents a number of aliases.
    Example: "unlimited"

  - `result.data.maximum_passenger_apps` (any)
    The account's maximum number of Ruby applications.
  * unlimited
  * An integer that represents a number of applications.
    Example: "unlimited"

  - `result.data.maximum_subdomains` (any)
    The account's maximum number of subdomains.
* unlimited
* An integer that represents a number of subdomains.
    Example: "unlimited"

  - `result.data.mxcheck` (object)
    Domains and their mail exchanger (MX) type.
    Example: {"example.com":"local","example2.com":"remote"}

  - `result.data.mxcheck.additionalProperties` (string)
    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.
    Enum: "local", "remote", "secondary"

  - `result.data.notify_account_authn_link` (integer)
    Whether the systems sends a notification when someone links the account to an external authentication account.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_account_authn_link_notification_disabled` (integer)
    Whether the systems sends a notification when someone disables notifications for external authentication account links.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_account_login` (integer)
    Whether the system sends a notification when someone logs in to the account.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_account_login_for_known_netblock` (integer)
    Whether the system sends a notification when a user on a known netblock logs in to the account.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_account_login_notification_disabled` (integer)
    Whether the system sends a notification when someone disables notifications for account logins.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_autossl_expiry` (integer)
    Whether the system sends a notification when an AutoSSL certificate expires.
* 1 - Notifies.
* 0 - Doesn't notify
    Enum: 0, 1

  - `result.data.notify_autossl_expiry_coverage` (integer)
    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.
    Enum: 0, 1

  - `result.data.notify_autossl_renewal_coverage` (integer)
    Whether the system sends a notification when AutoSSL renews a certificate.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_autossl_renewal_coverage_reduced` (integer)
    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.
    Enum: 0, 1

  - `result.data.notify_autossl_renewal_uncovered_domains` (integer)
    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.
    Enum: 0, 1

  - `result.data.notify_bandwidth_limit` (integer)
    Whether the systems sends a notification when the account reaches its bandwidth quota.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_contact_address_change` (integer)
    Whether the systems sends a notification when someone changes the contact address for the account.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_contact_address_change_notification_disabled` (integer)
    Whether the systems sends a notification when someone disables the notification for contact address changes.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_disk_limit` (integer)
    Whether the systems sends a notification when the account reaches its disk usage limit.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_password_change` (integer)
    Whether the systems sends a notification when someone changes the account's password.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_password_change_notification_disabled` (integer)
    Whether the systems sends a notification when someone disables notifications for password changes.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_ssl_expiry` (integer)
    Whether the systems sends a notification when an SSL certificate on the account expires.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_twofactorauth_change` (integer)
    Whether the systems sends a notification when the account's Two-Factor Authentication (2FA) credentials change.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.notify_twofactorauth_change_notification_disabled` (integer)
    Whether the systems sends a notification when someone disables notifications for 2FA.
* 1 - Notifies.
* 0 - Doesn't notify.
    Enum: 0, 1

  - `result.data.owner` (string)
    The account's owner.
* root
* A reseller account's username.
* The account's username.
    Example: "root"

  - `result.data.package_extensions` (array)
    The account's package extensions.
    Example: ["ext1","ext2","ext3"]

  - `result.data.plan` (string)
    The account's hosting package.
    Example: "packagename"

  - `result.data.pushbullet_access_token` (string)
    The account's Pushbullet access token.
    Example: "1234567890"

  - `result.data.shell` (string)
    The account's shell.
    Example: "/bin/bash"

  - `result.data.spf_enabled` (integer)
    Whether Sender Policy Framework (SPF) is enabled.
* 1 - Enabled.
* 0 - Not enabled.
    Enum: 0, 1

  - `result.data.ssl_default_key_type` (string)
    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”).
    Enum: "system", "rsa-2048", "rsa-4096", "ecdsa-prime256v1", "ecdsa-secp384r1"

  - `result.data.theme` (string)
    The account's current theme.
    Example: "jupiter"

  - `result.data.uid` (integer)
    The account's user ID on the system.
    Example: 1234

  - `result.data.user` (string)
    An existing account's username.
    Example: "username"

  - `result.data.utf8_mailbox` (integer)
    Whether UTF-8-encoded mailbox names are enabled for the cPanel account.
* 1 - Enabled.
* 0 - Not enabled.
    Enum: 0, 1

  - `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.