--- title: "Return all domains' hosting configuration" method: GET path: "/DomainInfo/domains_data" tags: ["DomainInfo", "Domain Information"] --- # Return all domains' hosting configuration `GET /DomainInfo/domains_data` This function lists user data for the cPanel account's domains. **Note:** This function retrieves data from the `/var/cpanel/userdata/user/domain` file, where `user` represents the cPanel account username and `domain` represents the domain. For this reason, actual output may not contain all of the returns that this document lists. ## Query parameters - `format` 'hash' | 'list' - `hide_temporary_domains` 1 | 0 - `return_https_redirects_status` 1 | 0 ## 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` union — An object containing information about a cPanel account's domains. The output of this function changes, based on the `format` parameter value. - HashOutput - `addon_domains` Contents[] — An array of objects containing information about each addon domain. - `all_aliases_valid` 1 | 0 — Whether a valid SSL certificate exists on the domain's aliases. * `1` — A valid SSL certificate exists. * `0` — A valid SSL certificate does **not** exist. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `can_https_redirect` 1 | 0 — 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. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `documentroot` string, path — The absolute path to the domain's document root. - `domain` string, domain — The domain's name. - `group` string — The domain's group. - `hascgi` 1 | 0 — Whether CGI is enabled for the domain. * `1` — Enabled. * `0` — Disabled. - `homedir` string, path — The absolute path to the cPanel account's home directory. - `ip` string, ipv4 — The domain's IPv4 address. - `ipv6` string, ipv6, nullable — The domain's IPv6 address. * null — The account does **not** use IPv6. - `is_https_redirecting` 1 | 0 — Whether the domain redirects to `https`. * `1` — The domain redirects to `https`. * `0` — The domain does **not** redirect to `https`. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `is_temporary` 1 | 0 — Whether the domain is a temporary domain. * `1` — The domain is temporary. * `0` — The domain is not temporary. - `no_cache_update` 1 | 0 — Whether the domain is subject to cache updates. * `1` — The domain updates caches. * `0` — The domain does **not** update caches. - `owner` string — The WHM account (`root` or a reseller) that owns the cPanel account. - `serveradmin` string, email — The domain's administrator's contact email address. - `serveralias` string, domain — A space-separated list of the domain's aliases. - `servername` string, domain — The domain's identifier on the server. - `type` 'addon_domain' | 'sub_domain' | 'parked_domains' — The type of domain: * `addon_domain` — The domain is an addon domain. * `sub_domain` — The domain is a subdomain. * `parked_domain` — The domain is a parked domain (domain alias). - `usecanonicalname` 'On' | 'Off' — The domain's Canonical Name (CNAME) setting. * `On` — Use the domain's CNAME. * `Off` — Do **not** use the domain's CNAME. - `user` string, username — The cPanel account's username. - `userdirprotect` 1 | 0 — The domain's [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) setting. * `1` — Enabled. * `0` — Disabled. - `main_domain` MainDomainContents[] — An array of objects containing information about the main domain. - `all_aliases_valid` 1 | 0 — Whether a valid SSL certificate exists on the domain's aliases. * `1` — A valid SSL certificate exists. * `0` — A valid SSL certificate does **not** exist. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `can_https_redirect` 1 | 0 — 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. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `customlog` object — The domain's [Apache log](http://httpd.apache.org/docs/2.2/mod/mod_log_config.html) information. - `format` string — The [log file](https://httpd.apache.org/docs/2.2/mod/mod_log_config.html#logformat)'s format. - `target` string — The absolute path to the domain's log file in the `domlogs` directory. - `documentroot` string, path — The absolute path to the domain's document root. - `domain` string, domain — The domain's name. - `group` string — The domain's group. - `hascgi` 1 | 0 — Whether CGI is enabled for the domain. * `1` — Enabled. * `0` — Disabled. - `homedir` string, path — The absolute path to the cPanel account's home directory. - `ifmodulemodsuphpc` object — Information about PHP scripts and suPHP. - `group` string — If suPHP is enabled, PHP scripts run as this group. - `ip` string, ipv4 — The domain's IPv4 address. - `ipv6` string, ipv6, nullable — The domain's IPv6 address. * null — The account does **not** use IPv6. - `is_https_redirecting` 1 | 0 — Whether the domain redirects to `https`. * `1` — The domain redirects to `https`. * `0` — The domain does **not** redirect to `https`. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `no_cache_update` 1 | 0 — Whether the domain is subject to cache updates. * `1` — The domain updates caches. * `0` — The domain does **not** update caches. - `owner` string — The WHM account (`root` or a reseller) that owns the cPanel account. - `scriptalias` object — The domain's CGI information. - `path` string, path — The absolute path to the domain's CGI directory. - `url` string, path — The domain's CGI directory. - `serveradmin` string, email — The domain's administrator's contact email address. - `serveralias` string, domain — A space-separated list of the domain's aliases. - `servername` string, domain — The domain's identifier on the server. - `type` 'main_domain' — The domain is the cPanel account's main domain. * `main_domain` is the only possible value. - `usecanonicalname` 'On' | 'Off' — The domain's Canonical Name (CNAME) setting. * `On` — Use the domain's CNAME. * `Off` — Do **not** use the domain's CNAME. - `user` string, username — The cPanel account's username. - `userdirprotect` 1 | 0 — The domain's [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) setting. * `1` — Enabled. * `0` — Disabled. - `parked_domains` Contents[] — An array of objects containing information about each parked domain. - `all_aliases_valid` 1 | 0 — Whether a valid SSL certificate exists on the domain's aliases. * `1` — A valid SSL certificate exists. * `0` — A valid SSL certificate does **not** exist. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `can_https_redirect` 1 | 0 — 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. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `documentroot` string, path — The absolute path to the domain's document root. - `domain` string, domain — The domain's name. - `group` string — The domain's group. - `hascgi` 1 | 0 — Whether CGI is enabled for the domain. * `1` — Enabled. * `0` — Disabled. - `homedir` string, path — The absolute path to the cPanel account's home directory. - `ip` string, ipv4 — The domain's IPv4 address. - `ipv6` string, ipv6, nullable — The domain's IPv6 address. * null — The account does **not** use IPv6. - `is_https_redirecting` 1 | 0 — Whether the domain redirects to `https`. * `1` — The domain redirects to `https`. * `0` — The domain does **not** redirect to `https`. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `is_temporary` 1 | 0 — Whether the domain is a temporary domain. * `1` — The domain is temporary. * `0` — The domain is not temporary. - `no_cache_update` 1 | 0 — Whether the domain is subject to cache updates. * `1` — The domain updates caches. * `0` — The domain does **not** update caches. - `owner` string — The WHM account (`root` or a reseller) that owns the cPanel account. - `serveradmin` string, email — The domain's administrator's contact email address. - `serveralias` string, domain — A space-separated list of the domain's aliases. - `servername` string, domain — The domain's identifier on the server. - `type` 'addon_domain' | 'sub_domain' | 'parked_domains' — The type of domain: * `addon_domain` — The domain is an addon domain. * `sub_domain` — The domain is a subdomain. * `parked_domain` — The domain is a parked domain (domain alias). - `usecanonicalname` 'On' | 'Off' — The domain's Canonical Name (CNAME) setting. * `On` — Use the domain's CNAME. * `Off` — Do **not** use the domain's CNAME. - `user` string, username — The cPanel account's username. - `userdirprotect` 1 | 0 — The domain's [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) setting. * `1` — Enabled. * `0` — Disabled. - `sub_domains` Contents[] — An array of objects containing information about each subdomain. - `all_aliases_valid` 1 | 0 — Whether a valid SSL certificate exists on the domain's aliases. * `1` — A valid SSL certificate exists. * `0` — A valid SSL certificate does **not** exist. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `can_https_redirect` 1 | 0 — 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. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `documentroot` string, path — The absolute path to the domain's document root. - `domain` string, domain — The domain's name. - `group` string — The domain's group. - `hascgi` 1 | 0 — Whether CGI is enabled for the domain. * `1` — Enabled. * `0` — Disabled. - `homedir` string, path — The absolute path to the cPanel account's home directory. - `ip` string, ipv4 — The domain's IPv4 address. - `ipv6` string, ipv6, nullable — The domain's IPv6 address. * null — The account does **not** use IPv6. - `is_https_redirecting` 1 | 0 — Whether the domain redirects to `https`. * `1` — The domain redirects to `https`. * `0` — The domain does **not** redirect to `https`. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `is_temporary` 1 | 0 — Whether the domain is a temporary domain. * `1` — The domain is temporary. * `0` — The domain is not temporary. - `no_cache_update` 1 | 0 — Whether the domain is subject to cache updates. * `1` — The domain updates caches. * `0` — The domain does **not** update caches. - `owner` string — The WHM account (`root` or a reseller) that owns the cPanel account. - `serveradmin` string, email — The domain's administrator's contact email address. - `serveralias` string, domain — A space-separated list of the domain's aliases. - `servername` string, domain — The domain's identifier on the server. - `type` 'addon_domain' | 'sub_domain' | 'parked_domains' — The type of domain: * `addon_domain` — The domain is an addon domain. * `sub_domain` — The domain is a subdomain. * `parked_domain` — The domain is a parked domain (domain alias). - `usecanonicalname` 'On' | 'Off' — The domain's Canonical Name (CNAME) setting. * `On` — Use the domain's CNAME. * `Off` — Do **not** use the domain's CNAME. - `user` string, username — The cPanel account's username. - `userdirprotect` 1 | 0 — The domain's [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) setting. * `1` — Enabled. * `0` — Disabled. - union - Contents - `all_aliases_valid` 1 | 0 — Whether a valid SSL certificate exists on the domain's aliases. * `1` — A valid SSL certificate exists. * `0` — A valid SSL certificate does **not** exist. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `can_https_redirect` 1 | 0 — 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. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `documentroot` string, path — The absolute path to the domain's document root. - `domain` string, domain — The domain's name. - `group` string — The domain's group. - `hascgi` 1 | 0 — Whether CGI is enabled for the domain. * `1` — Enabled. * `0` — Disabled. - `homedir` string, path — The absolute path to the cPanel account's home directory. - `ip` string, ipv4 — The domain's IPv4 address. - `ipv6` string, ipv6, nullable — The domain's IPv6 address. * null — The account does **not** use IPv6. - `is_https_redirecting` 1 | 0 — Whether the domain redirects to `https`. * `1` — The domain redirects to `https`. * `0` — The domain does **not** redirect to `https`. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `is_temporary` 1 | 0 — Whether the domain is a temporary domain. * `1` — The domain is temporary. * `0` — The domain is not temporary. - `no_cache_update` 1 | 0 — Whether the domain is subject to cache updates. * `1` — The domain updates caches. * `0` — The domain does **not** update caches. - `owner` string — The WHM account (`root` or a reseller) that owns the cPanel account. - `serveradmin` string, email — The domain's administrator's contact email address. - `serveralias` string, domain — A space-separated list of the domain's aliases. - `servername` string, domain — The domain's identifier on the server. - `type` 'addon_domain' | 'sub_domain' | 'parked_domains' — The type of domain: * `addon_domain` — The domain is an addon domain. * `sub_domain` — The domain is a subdomain. * `parked_domain` — The domain is a parked domain (domain alias). - `usecanonicalname` 'On' | 'Off' — The domain's Canonical Name (CNAME) setting. * `On` — Use the domain's CNAME. * `Off` — Do **not** use the domain's CNAME. - `user` string, username — The cPanel account's username. - `userdirprotect` 1 | 0 — The domain's [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) setting. * `1` — Enabled. * `0` — Disabled. - MainDomainContents - `all_aliases_valid` 1 | 0 — Whether a valid SSL certificate exists on the domain's aliases. * `1` — A valid SSL certificate exists. * `0` — A valid SSL certificate does **not** exist. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `can_https_redirect` 1 | 0 — 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. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `customlog` object — The domain's [Apache log](http://httpd.apache.org/docs/2.2/mod/mod_log_config.html) information. - `format` string — The [log file](https://httpd.apache.org/docs/2.2/mod/mod_log_config.html#logformat)'s format. - `target` string — The absolute path to the domain's log file in the `domlogs` directory. - `documentroot` string, path — The absolute path to the domain's document root. - `domain` string, domain — The domain's name. - `group` string — The domain's group. - `hascgi` 1 | 0 — Whether CGI is enabled for the domain. * `1` — Enabled. * `0` — Disabled. - `homedir` string, path — The absolute path to the cPanel account's home directory. - `ifmodulemodsuphpc` object — Information about PHP scripts and suPHP. - `group` string — If suPHP is enabled, PHP scripts run as this group. - `ip` string, ipv4 — The domain's IPv4 address. - `ipv6` string, ipv6, nullable — The domain's IPv6 address. * null — The account does **not** use IPv6. - `is_https_redirecting` 1 | 0 — Whether the domain redirects to `https`. * `1` — The domain redirects to `https`. * `0` — The domain does **not** redirect to `https`. **Note:** This return **only** appears if you set the `return_https_redirects_status` parameter to `1`. - `no_cache_update` 1 | 0 — Whether the domain is subject to cache updates. * `1` — The domain updates caches. * `0` — The domain does **not** update caches. - `owner` string — The WHM account (`root` or a reseller) that owns the cPanel account. - `scriptalias` object — The domain's CGI information. - `path` string, path — The absolute path to the domain's CGI directory. - `url` string, path — The domain's CGI directory. - `serveradmin` string, email — The domain's administrator's contact email address. - `serveralias` string, domain — A space-separated list of the domain's aliases. - `servername` string, domain — The domain's identifier on the server. - `type` 'main_domain' — The domain is the cPanel account's main domain. * `main_domain` is the only possible value. - `usecanonicalname` 'On' | 'Off' — The domain's Canonical Name (CNAME) setting. * `On` — Use the domain's CNAME. * `Off` — Do **not** use the domain's CNAME. - `user` string, username — The cPanel account's username. - `userdirprotect` 1 | 0 — 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` 1 | 0 — * `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)