Child pages
  • WHM API 1 Functions - resolvedomainname

Versions Compared

Key

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

 

Description

Excerpt

This function resolves a domain's IP address.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/resolvedomainname?api.version=1&domain=example.com
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/resolvedomainname?api.version=1&domain=example.com
Expand
titleCommand Line
Code Block
languagebash
whmapi1 resolvedomainname domain=example.com

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "data": {
    "ip": "192.168.0.20"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "resolvedomainname"
  }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <data>
        <ip>192.168.0.20</ip>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>resolvedomainname</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain.

A valid domain name.example.com

Returns

ReturnTypeDescriptionPossible valuesExample
ipstringThe domain's IP address.A valid IP address.192.168.0.20