Child pages
  • WHM API 1 Functions - listzones

Versions Compared

Key

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

Description

Excerpt

This function lists the server's DNS zones.

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

Panel
bgColor#F2F2F2
borderStylenone

Examples 




Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/listzones?api.version=1



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/listzones?api.version=1



Expand
titleCommand Line


Code Block
languagebash
whmapi1 listzones 

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "data": {
    "zone": [
      {
        "domain": "example1.com",
        "zonefile": "example1.com.db"
      },
      {
        "domain": "example2.com",
        "zonefile": "example2.com.db"
      }
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "listzones"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
    <data>
        <zone>
            <domain>example1.com</domain>
            <zonefile>example1.com.db</zonefile>
        </zone>
        <zone>
            <domain>example2.com</domain>
            <zonefile>example2.com.db</zonefile>
        </zone>
     </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>listzones</command>
    </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
zonearray of hashesAn array of hashes of zone information.This array contains a hash for each zone. The hash for each zone contains the zonefile and domain returns. 

zonefile

string

The zone file's name.

The function returns this value in the zone hash.

A valid zone file name.

example.net.db

domain

string

The domain name.

The function returns this value in the zone hash.

A valid domain on the server.

example.com