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

 

Description

This function resolves a domain's IP address.

Examples 


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


Notes:

  • 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": {
    "ip": "192.168.0.20"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "resolvedomainname"
  }
}
 Output (XML)
<result>
    <data>
        <ip>192.168.0.20</ip>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>resolvedomainname</command>
    </metadata>
</result>


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.

A valid domain name.example.com

Returns

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