WHM API 1 Functions - killdns

The WHM API 1 adddns function adds an XDNS entry for a domain in the following locations:
- The /var/cpanel/users/USER file, where USER represents the domain's owner.
- The /etc/vdomainaliases/DOMAIN directory, where DOMAIN represents the new zone's domain.
- The /etc/vfilters/DOMAIN directory, where DOMAIN represents the new zone's domain.
This function does not automatically delete these entries. You must manually delete these entries, or you cannot use this domain as a value in other API functions.
You cannot delete other DNS zones that reside on Write-only servers in a DNS cluster.

Important:

In cPanel & WHM version 76 and later, when you disable the DNS role, the system disables this function.

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/killdns?api.version=1&domain=example.com

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/killdns?api.version=1&domain=example.com

Command Line

whmapi1 killdns domain=example.com

Notes:

Unless otherwise noted, 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)

{
  "metadata": {
    "version": 1,
    "reason": "Zones Removed",
    "output": {
      "raw": "example.com => deleted from example. \n"
    },
    "result": 1,
    "command": "killdns"
  }
}

Output (XML)

<result>
    <metadata>
        <version>1</version>
        <reason>Zones Removed</reason>
        <output>
            <raw>example.com =&gt; deleted from example.</raw>
        </output>
        <result>1</result>
        <command>killdns</command>
    </metadata>
</result>

Note:

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

Parameters

Parameter Type Description Possible values Example

domain

string

Required

The zone record's domain.

A valid domain name on the server.

example.com

Returns

This function only returns metadata.

Function information

API Version:

WHM API 1

Available in:

WHM 11+

Methods:

GET, POST

Required Parameters:

domain

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Functions - listmxs — This function lists a domain's MX records.
Page:

WHM API 1 Functions - getzonerecord — This function returns a line from a domain's DNS zone configuration.
Page:

WHM API 1 Functions - addzonerecord - Reverse DNS — This function uses PTR records to add reverse DNS functionality.
Page:

WHM API 1 Functions - editzonerecord — This function edits a DNS zone record.
Page:

WHM API 1 Functions - addzonerecord — This function adds a DNS zone record.

Child pages