Software Development Kit

cPanel & WHM's API [+] cPanel & WHM's API [-]


Modules and Plugins [+] Modules and Plugins [-]


cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]


cPAddons (Site Software) [+] cPAddons (Site Software) [-]


System Administration [+] System Administration [-]


Developer Software [+] Developer Software [-]


Back to All Documentation

List DNS Zones — listzones

This function will generate a list of all domains and corresponding DNS zones associated with your server.

Calling Functions

Using the XML API

To use the XML API to perform the listzones function from within your custom script:

  • Append the /xml-api/listzones function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/xml-api/listzones

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Using the JSON API

To use the JSON API to perform the listzones function from within your custom script:

  • Append the /json-api/listzones function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/json-api/listzones

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Variables

Input

None

Output

  • listzones — Root-level XML tag for the output of the listzones function.
    • zone — Container for the DNS zone.
      • domain (string) — Domain name. Example: example.com
      • zonefile (string) — Zone file name. Example: example.com.db

Examples

XML API

Calling https://example.com:2087/xml-api/listzones in WebHost Manager will produce output similar to:

<listzones>
   <zone>
       <domain>example.com</domain>
       <zonefile>example.com.db</zonefile>
   </zone>
   <zone>
       <domain>example.net</domain>
       <zonefile>example.net.db</zonefile>
   </zone>
</listzones>

JSON API

Calling https://example.com:2087/json-api/listzones in WebHost Manager will produce output similar to:

{
   "zone":[
      {
         "zonefile":"example.com.db",
         "domain":"example.com"
      },
      {
         "zonefile":"example.net.db",
         "domain":"example.net"
      }
   ]
}

Topic revision: r7 - 29 Sep 2009 - 17:55:11 - MelanieSeibert