Delete domain

This function deletes a domain.

Note:

This function does not remove an addon domain's associated subdomain. You must also run this function for the associated subdomain.

Authorizations:
query Parameters
domain
required
string <domain>

The name of the domain to delete.

Example: domain=example.com

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  delete_domain \
  domain='example.com'

Response samples

Content type
application/json
{
  • "data": {
    • "type": "addon",
    • "username": "username"
    },
  • "metadata": {
    • "command": "delete_domain",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}