Child pages
  • WHM API 1 Functions - getdomainowner

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function lists the owner of a domain.


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/getdomainowner?api.version=1&domain=example.com



Expand
titleCommand Line


Code Block
languagebash
whmapi1 getdomainowner domain=example.com

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "data": {
    "user": "username"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "getdomainowner"
  }
}



Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


   

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
titleNote:

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