---
title: "Return domain's hosting configuration"
method: GET
path: "/DomainInfo/single_domain_data"
tags: ["DomainInfo", "Domain Information"]
---

# Return domain's hosting configuration

`GET /DomainInfo/single_domain_data`

This function lists user data for a domain.

**Important:**

  This function retrieves data from the `/var/cpanel/userdata/user/domain` file, where `user` represents the cPanel account username and `domain` represents the domain.
  * Because aliases (parked domains) do **not** use a user data file, this function **cannot** query information for aliases. To retrieve information for an alias, specify the associated main or addon domain.
  * Due to differences in user data files, the function's actual output may not contain all of the returns that this document lists.

## Query parameters

- `domain` string, domain, required
- `hide_temporary_domains` 1 | 0
- `return_https_redirect_status` 0 | 1

## 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
      - `all_aliases_valid` 0 | 1 — Whether a valid SSL certificate exists on the domain's aliases. * `1` - A valid SSL certificate exists on the aliases. * `0` - A valid SSL certificate does **not** exist on the aliases. **Important:** This return only appears if you set the `return_https_redirects_status` parameter to `1`.
      - `can_https_redirect` 0 | 1 — Whether a valid SSL certificate exists or AutoSSL runs on the domain. * `1` - A valid SSL certificate exists or AutoSSL runs. * `0` - A valid SSL certificate does **not** exist, and AutoSSL does not run. **Important:** This return only appears if you set the `return_https_redirects_status` parameter to `1`.
      - `customlog` object — An object containing Apache log information.
        - `domain` string — The `target` log file's domain. An [Apache log](http://httpd.apache.org/docs/2.2/mod/mod_log_config.html) domain. Generally, this value is `combined`.
        - `target` string, path — The absolute path to the domain's log file.
      - `documentroot` string, path — The absolute path to the domain's document root.
      - `domain` string, domain — The domain name on the cPanel account.
      - `group` string — The domain's group name.
      - `hascgi` 0 | 1 — Whether CGI is enabled for the domain. * `1` - Enabled. * `0` - Disabled.
      - `homedir` string, path — The absolute path to the account's home directory.
      - `ifmodulemodsuphpc` object — An object containing information about PHP scripts and suPHP.
        - `group` string — If suPHP is enabled, the group that PHP scripts run as.
      - `ip` string, ipv4 — The domain's IP address.
      - `is_https_redirecting` 0 | 1 — Whether the domain redirects to https. * `1` - Redirects. * `0` - Does **not** redirect. **Important:** This return only appears if you set the `return_https_redirects_status` parameter to `1`.
      - `is_temporary` 0 | 1 — Whether the domain is a temporary domain. * `1` — The domain is temporary. * `0` — The domain is not temporary.
      - `options` string — The Apache `Options` directive for the domain.
      - `owner` string, username — The WHM account (root or a reseller) that owns the cPanel account.
      - `phpopenbasedirprotect` 0 | 1 — The domain's `open_basedir` setting. * `1` - Enabled. * `0` - Disabled. **Note:** In EasyApache 4, change this directive in the *Editor Mode* section of WHM's [*MultiPHP INI Editor*](https://go.cpanel.net/whmdocsMultiPHPINIEditor) interface (*WHM >> Home >> Software >> MultiPHP INI Editor*).
      - `port` integer — Apache's port to access the domain.
      - `scriptalias` object — An object containing CGI information.
        - `path` string, path — The absolute path to the domain's CGI directory.
        - `url` string, url-path — The domain's CGI directory.
      - `serveradmin` string, email — The domain's administrator's contact email address.
      - `serveralias` string — A space-separated list of the domain's aliases.
      - `servername` string, domain — The domain's identifier on the server.
      - `type` 'addon_domain' | 'sub_domain' | 'main_domain' | 'parked_domain' — The domain type. * `addon_domain` - The domain is an addon domain. * `sub_domain` - The domain is a subdomain. * `main_domain` - The domain is the account's main domain. * `parked_domain` - The domain is a parked domain (domain alias).
      - `usecanonicalname` 'On' | 'Off' — The domain's Canonical Name (CNAME) setting. * `On` - Use the CNAME. * `Off` - Do **not** use the CNAME.
      - `user` string, username — The cPanel account's username.
      - `userdirprotect` 0 | 1 — The domain's [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) setting. * `1` - Enabled. * `0` - Disabled.
    - `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 an 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)