---
title: "Return domain user information"
method: GET
path: "/domainuserdata"
tags: ["Domain Information"]
---

# Return domain user information

`GET /domainuserdata`

This function retrieves domain data.

## Query parameters

- `domain` string, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `userdata` object — The domain information.
      - `customlog` object[] — A list of objects of Apache log information.
        - `format` string — The custom log's format. A valid Apache log format.
        - `target` string — An Apache custom log's location. The absolute path to the log file.
      - `documentroot` string — The path to the domain's document root. A valid filepath.
      - `group` string — The account's group name. A valid group name.
      - `hascgi` 0 | 1 — Whether CGI is enabled for the account. - 1 Enabled. - 0 Disabled.
      - `homedir` string — The path to the domain's home directory. The absolute path to the domain's home directory.
      - `ip` string — The domain's IP address. A valid IP address.
      - `owner` string — The WHM user who owns the cPanel account. A valid WHM username.
      - `phpopenbasedirprotect` 0 | 1 — Whether the PHP open_basedir tweak is enabled. - 1 Enabled. - 0 Disabled.
      - `port` integer — Apache's port to access the domain. A valid port number.
      - `scriptalias` object[] — an object containing Apache ScriptAlias information.
        - `path` string — The path to Apache's CGI scripts. The url alias redirects to this location. A valid URL or absolute file path.
        - `url` string — The alias URL. This URL redirects to the path URL. A valid URL or file path.
      - `serveradmin` string — The account owner's contact email address. A valid email address.
      - `serveralias` string — The domain's aliases. A space-separated list of domain aliases.
      - `servername` string — The main domain on the domain's account. A valid domain name.
      - `usecanonicalname` string — The domain's setting for canonical names (CNAMEs). - On - Off
      - `user` string — The cPanel account username. A valid cPanel username.
      - `userdirprotect` string — The domain's setting for the Apache mod_userdir Tweak. - On - Off
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — - 1 - Success - 0 - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)