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

Remove a DNS Zone — killdns

This function deletes a DNS zone.

Calling Functions

Using the XML API

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

  • Append the /xml-api/killdns 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/killdns

  • 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 killdns function from within your custom script:

  • Append the /json-api/killdns 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/killdns

  • 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

The killdns function takes the following required variable as input:
  • domain (string) — Domain name for the zone to be deleted.

Output

  • killdns — Root-level XML tag for the output of the killdns function.
    • result (string) — Container for the results of the zone deletion.
      • rawout (HTML) — Raw output in HTML.
      • status (boolean) — Status of the deletion request.
        • 1 — success.
        • 0 — failure.
      • statusmsg (string) — Information about the status of the request.

Examples

XML API

Calling https://example.com:2087/xml-api/killdns?domain=example.com in WebHost Manager will produce output similar to:

<killdns>
   <result>      
      <rawout>
               example.com -> deleted from host1.
               example.com -> deleted from host2.         
      </rawout>
      <status>1</status>   
      <statusmsg>Zones Removed</statusmsg>
   </result>
</killdns>

JSON API

Calling https://example.com:2087/json-api/killdns?domain=example.com in WebHost Manager will produce output similar to:

{
   "result":[
      {
         "status":1,
         "statusmsg":"Zones Removed",
         "rawout":"example.com => deleted from server. \n"
      }
   ]
}

Topic revision: r5 - 29 Sep 2009 - 17:54:07 - MelanieSeibert