Return domain user information

This function retrieves domain data.

Authorizations:
query Parameters
domain
required
string

The account's main domain.

Example: domain=example.com

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  domainuserdata \
  domain='example.com'

Response samples

Content type
application/json
{
  • "data": {
    • "userdata": {
      • "customlog": [
        • {
          • "format": "combined",
          • "target": "/usr/local/apache/domlogs/example.com"
          }
        ],
      • "documentroot": "/home/username/public_html",
      • "group": "reseller_username",
      • "hascgi": 1,
      • "homedir": "/home/username",
      • "ip": "10.0.0.1",
      • "owner": "root",
      • "phpopenbasedirprotect": 1,
      • "port": 80,
      • "scriptalias": [
        • {
          • "path": "/home/user/public_html/cgi-bin/",
          • "url": "/cgi-bin/"
          }
        ],
      • "serveradmin": "owner@example.com",
      • "serveralias": "parkeddomain.com www.parkeddomain.com seconddomain.com",
      • "servername": "example.com",
      • "usecanonicalname": "Off",
      • "user": "user",
      • "userdirprotect": "Off"
      }
    },
  • "metadata": {
    • "command": "domainuserdata",
    • "reason": "Obtained userdata.",
    • "result": 1,
    • "version": 1
    }
}