cPanel API 2 Functions - DnsLookup::name2ip - Knowledgebase

Description

This function returns a domain's IP address.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=DnsLookup&cpanel_jsonapi_func=name2ip&domain=example.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Return the IP address for example.com
$return_ip_address = $cpanel->api2(
    'DnsLookup', 'name2ip',
        array(       
            'domain'      => 'example.com',
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Return the IP address for example.com.
my $return_ip_address = $cpliveapi->api2(
    'DnsLookup', 'name2ip',
    {
        'domain'      => 'example.com',
 
    }
 );

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "name2ip",
    "data": [
      {
        "domain": example.com,
        "statusmsg": "Resolved",
        "ip": 192.168.0.20,
        "status": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "DnsLookup"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Input	Type	Description	Possible values	Example
domain	string	Required The domain.	A valid domain name on the account.	example.com

Input

Type

Description

Possible values

Example

domain

string

Required

The domain.

A valid domain name on the account.

example.com

Returns

Return	Type	Description	Possible values	Example
domain	string	The domain.	The domain input parameter's value.	example.com
statusmsg	string	Whether the IP address resolved.	Resolved Could not resolve	Resolved
ip	string	The domain's IP address.	An IP address.	192.168.0.20
status	string	Whether the query succeeded.	1 — The query succeeded. 0 — The query failed.	1
reason	string	A reason for failure. Note: This function only returns a reasonvalue if there was an error.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories