You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • WHM API 1 Functions - has_local_authority
Skip to end of metadata
Go to start of metadata

Description

This function checks whether the local server has the authority to publish changes for the domain's DNS records.

Important:

In cPanel & WHM version 76 and later, when you disable the DNS role, the system disables this function.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/has_local_authority?api.version=1&domain=example.com&domain=example3.com


Note:

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

 Command Line
whmapi1 has_local_authority domain=example.com domain=example2.com domain=example3.com


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
	"data": {
		"records": [{
				"domain": "example.com",
				"zone": "example.com",
				"nameservers": [
					"ns1.example.com",
					"ns2.example.com"
				],
				"local_authority": 1
			},
			{
				"domain": "example2.com",
				"nameservers": [],
				"local_authority": 0
			},
			{
				"nameservers": [],
				"zone": "null",
				"local_authority": 0,
				"domain": "example3.com",
				"error": "(XID qdbmuk) DNS query (example3.com/SOA) timeout!"
			}
		],
		"metadata": {
			"result": 1,
			"command": "has_local_authority",
			"reason": "OK",
			"version": 1
		}
	}
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM 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 or increment the parameter name. For example, to check three domains, you could:

  • Use the domain parameter multiple times.
  • Use the domain, domain-1, and domain-2 parameters.
A valid domain.example.com

Returns

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

domain

string

The queried domain.

This function returns this value in the records array.

A valid domain.example.com

zone

string

The DNS zone that contains the domain's DNS records, if one exists.

This function returns this value in the records array.

  • A valid DNS zone.
  • null — No valid DNS zone.
example.com

nameservers

array of strings

The domain's authoritative nameservers, if any exist.

This function returns this value in the records array.

A valid nameserver.

"ns1.example.com",

"ns2.example.com"


local_authority

Boolean

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

This function returns this value in the records 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

error

string

A message that details the reason why the local server's authoritative check failed.

Note:

  • The function only returns this value when the check fails.
  • We added this return in cPanel & WHM version 88.

This function returns this value in the records array.

An error message.(XID qdbmuk) DNS query (example3.com/SOA) timeout!