Child pages
  • WHM API 1 Functions - getdomainowner
Skip to end of metadata
Go to start of metadata

Description

This function lists the owner of a domain.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/getdomainowner?api.version=1&domain=example.com
 Command Line
whmapi1 getdomainowner domain=example.com


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data": {
    "user": "username"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "getdomainowner"
  }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain for which you wish to query ownership.

A valid domain name on a cPanel account that you own.

example.com

Returns

ReturnTypeDescriptionPossible valuesExample
user
string

The user who owns the domain.

A valid username.

Note:

The function returns an undefined value if either of the following conditions exist:

  • Nobody on the server owns the domain.
  • The user who calls this function does not own the account of the domain's owner.
username