Description
This function performs an A record DNS query for the account's hostname.
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
LiveAPI PHP Class
$cpanel = new CPANEL();
$get_dns_record = $cpanel->api2(
'Net', 'dnszone',
array(
'host' => 'example.com',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $get_dns_record = $cpliveapi->api2(
'Net', 'dnszone',
{
'host' => '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": "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"
}
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
host
|
string
|
Required
The domain.
|
Any valid domain name.
|
example.com
|
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
line
|
string
|
The domain's DNS A records.
|
A DNS A Record.
|
example.com.\t\t900\tIN\tA\t12.45.148.5
|
|
reason
|
string
|
A reason for failure
Note:
This function only returns areason value 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
|
