Child pages
  • UAPI Functions - DNS::has_local_authority
Skip to end of metadata
Go to start of metadata

Description

This function checks whether the local server is authoritative for the domain's DNS records.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/DNS/has_local_authority?domain=example.com


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Check if the local server is authoritative for the domain's DNS records.
$poll = $cpanel->uapi(
    'DNS', 'has_local_authority',
    array(
        'domain' => '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.
 
# Check if the local server is authoritative for the domain's DNS records.
my $poll = $cpliveapi->uapi(
    'DNS', 'has_local_authority',
    {
        'domain' => 'example.com'
  }
);


Note:

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

 Command Line
uapi --user=username DNS has_local_authority domain=example.com domain=anotherexample.com


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
   "apiversion": 3,
   "module": "DNS",
   "func": "has_local_authority",
   "result": {
      "data": [
        {
          "domain": "example.com",
		  "zone": "example.com",
		  "nameservers": [
				"ns1.example.com",
				"ns2.example.com"
			],
		  "local_authority": 1
		},
		{
		  "domain": "anotherexample.com",
		  "nameservers": [
				],
		  "local_authority": 0 
        }
	 ]
  },
    "errors": null,
    "messages": null,
    "metadata": {
        "transformed": 1
            },
    "status": 1,
    "warnings": null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain to check whether the local server is authoritative for the domain's DNS records.

Note:

To check multiple domains, duplicate the parameter name. For example, use the domain=example.com, domain=example2.com, and domain=example3.com parameters.

A valid domain.example.com

Returns

ReturnTypeDescriptionPossible valuesExample
dataarray of hashesAn array that contains information about the authoritative status of a domain's local DNS zone files.Each hash contains the domain, zone, nameservers, and local_authority returns.

domain

string

The queried domain.

This function returns this value in the data array.

A valid domain.example.com

zone

string

The domain's DNS zone.

This function returns this value in the data array.

A valid DNS zone.

example.com

nameservers

array of strings

The domain's nameservers.

This function returns this value in the data array.

A list of valid nameservers.ns1.example.com

local_authority

Boolean

Whether the local server is authoritative for the domain's DNS records.

This function returns this value in the data array.

  • 1 — The local server is authoritative for the domain's DNS records.
  • 0 — The local server is not authoritative for the domain's DNS records.
1