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

Description

This function lists the server's DNS zones.

Important:

In cPanel & WHM version 76 and later, when you disable the DNS role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 



 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/listzones?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/listzones?api.version=1
 Command Line
whmapi1 listzones 


Notes:

  • 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": {
    "zone": [
      {
        "domain": "example1.com",
        "zonefile": "example1.com.db"
      },
      {
        "domain": "example2.com",
        "zonefile": "example2.com.db"
      }
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "listzones"
  }
}
 Output (XML)
<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>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

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