v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Variables

Account Information

Return cPanel account's configuration settings

This function retrieves the user's account configuration settings.

get/Variables/get_user_information

Query parameters

namestring

Example:domain

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.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_user_information",
  "module": "Variables",
  "result": {
    "data": {
      "backup_enabled": 1,
      "cgi_enabled": 1,
      "contact_email": "user@example.com",
      "contact_email_2": "user2@example.com",
      "cpanel_root_directory": "/usr/local/cpanel",
      "created": 1432220941,
      "created_in_version": "11.94.0.0",
      "database_owner": "root",
      "dead_domains": [
        "example.example.com"
      ],
      "demo_mode": 1,
      "disk_block_limit": 100000000,
      "dkim_enabled": 1,
      "domain": "example.com",
      "domains": [
        "example.com"
      ],
      "feature": {
        "custom_feature": 1
      },
      "feature_list": "feature_list",
      "gid": 5678,
      "home": "/home/user",
      "home_directory_links": [
        "symlink"
      ],
      "ip": "192.0.2.0",
      "lang": "english",
      "last_modified": 1416586493,
      "legacy_backup_enabled": 1,
      "locale": "en",
      "mailbox_format": "maildir",
      "mxcheck": {
        "example.com": "local",
        "example2.com": "remote"
      },
      "notify_account_authn_link": 1,
      "notify_account_authn_link_notification_disabled": 1,
      "notify_account_login": 1,
      "notify_account_login_for_known_netblock": 1,
      "notify_account_login_notification_disabled": 1,
      "notify_autossl_expiry": 1,
      "notify_autossl_expiry_coverage": 1,
      "notify_autossl_renewal_coverage": 1,
      "notify_autossl_renewal_coverage_reduced": 1,
      "notify_autossl_renewal_uncovered_domains": 1,
      "notify_bandwidth_limit": 1,
      "notify_contact_address_change": 1,
      "notify_contact_address_change_notification_disabled": 1,
      "notify_disk_limit": 1,
      "notify_password_change": 1,
      "notify_password_change_notification_disabled": 1,
      "notify_ssl_expiry": 1,
      "notify_twofactorauth_change": 1,
      "notify_twofactorauth_change_notification_disabled": 1,
      "owner": "root",
      "package_extensions": [
        "ext1",
        "ext2",
        "ext3"
      ],
      "plan": "packagename",
      "pushbullet_access_token": "1234567890",
      "shell": "/bin/bash",
      "spf_enabled": 1,
      "ssl_default_key_type": "rsa-2048",
      "theme": "jupiter",
      "uid": 1234,
      "user": "username",
      "utf8_mailbox": 1
    },
    "status": 1
  }
}