Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function performs an A record DNS query for the account's hostname. 

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=Net&cpanel_jsonapi_func=dnszone&host=example.com

Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Retrieve DNS A Record for example.com.
$get_dns_record = $cpanel->api2(
    'Net', 'dnszone',
		array(
		'host'				=> 'example.com',
	)
  );

Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Retrieve IP address traceroute.
my $get_dns_record = $cpliveapi->api2(
	'Net', 'dnszone',
		{
		'host'				=> 'example.com',
		}	
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 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.

 Command Line
cpapi2 --user=username Net dnszone host=example.com

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "dnszone",
    "data": [
      {
        "line": "example.com.\t\t900\tIN\tA\t12.45.148.5"
      },
      {
        "line": "example.com.\t\t172800\tIN\tNS\tns-743.awsdns-28.net."
      },
      {
        "line": "example.com.\t\t172800\tIN\tNS\tns-1484.awsdns-57.org."
      },
      {
        "line": "example.com.\t\t172800\tIN\tNS\tns-80.awsdns-10.com."
      },
      {
        "line": "example.com.\t\t172800\tIN\tNS\tns-1893.awsdns-44.co.uk."
      },
  
    ],
    "event": {
      "result": 1
    },
    "module": "Net"
  }
}

Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
hoststring

Required

The domain.

Any valid domain name.example.com

 

 

Returns

ReturnTypeDescriptionPossible valuesExample
 array of hashesAn array of hashes that contain the domain's DNS A records.This array of hashes includes the line return. 

line

string

The domain's DNS A records.

The function returns this value in the unnamed hash.

A DNS A Record.
example.com.\t\t900\tIN\tA\t12.45.148.5
reasonstring

A reason for failure

Note:

This function only returns a reason value if there was an error. 

A string that describes the error.This is an error message.
resultBoolean

Whether the function succeeded.

 

  • 1 — The function succeeded.
  • 0 — The function failed.
1