Child pages
  • cPanel API 2 Functions - Net::dnszone

Versions Compared

Key

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

Description

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

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
	)
  );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
		}	
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username Net dnszone host=example.com

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "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"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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
titleNote:

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