Child pages
  • WHM API 1 Functions - has_local_authority

Versions Compared

Key

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

Description

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

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledSendMailRoleNonVersion
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagetext
https://hostname.example.com:2087/cpsess##########/json-api/has_local_authority?api.version=1&domain=example.com

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleCommand Line


Code Block
languagebash
whmapi1 has_local_authority domain=example.com domain=anotherexample.com

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagebash
linenumberstrue
{
   "data": {
      "records": [
        {
          "domain": "example.com",
		  "zone": "example.com",
		  "nameservers": [
				"ns1.example.com",
				"ns2.example.com"
			],
		  "local_authority": 1
		},
		{
		  "domain": "anotherexample.com",
		  "nameservers": [
			],
		  "local_authority": 0 
        }
    ],
    "metadata": {
       "result": 1,
	   "command": "has_local_authority",
	   "reason": "OK",
	   "version": 1
    }
  }
}


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

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

Note
titleNote:

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
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 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.

This function returns this value in the records array.

A valid DNS zone.example.com

nameservers

array of strings

The domain's authoritative nameservers.

This function returns this value in the records array.

A list of valid authoritative nameservers.

"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