cPanel API 2 Functions - SubDomain::delsubdomain

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function deletes a subdomain.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=username&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SubDomain&cpanel_jsonapi_func=delsubdomain&domain=subdomain.example.com

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Remove a subdomain.
$delsubdomain = $cpanel->api2(
    'SubDomain', 'delsubdomain',
        array(
        'domain' => 'subdomain.example.com'
    )
);

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Remove a subdomain.
my $delsubdomain = $cpliveapi->api2(
    'SubDomain', 'delsubdomain',
    {
        'domain' => 'subdomain.example.com'
    }

);

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username SubDomain delsubdomain domain=subdomain.example.com

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
    "cpanelresult": {
        "apiversion": 2,
        "func": "delsubdomain",
        "data": [{
            "reason": "Bind reloading on example using rndc zone: [example.tld] The subdomain \"subdomain.example.com\" has been removed.",
            "result": 1
        }],
        "event": {
            "result": 1
        },
        "module": "SubDomain"
    }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Returns

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`domain`	string	Required The name of the subdomain to delete.	A valid domain name.	`subdomain.example.com` To delete the subdomain of an addon domain, separate the subdomain with an underscore (`_`) instead of a dot (`.`). For example, use the following format: `subdomain_addondomain.tld`

domain

string

Required

The name of the subdomain to delete.

A valid domain name.

subdomain.example.com

To delete the subdomain of an addon domain, separate the subdomain with an underscore (_) instead of a dot (.). For example, use the following format:

subdomain_addondomain.tld

Return	Type	Description	Possible values	Example
`reason`	string	A success or failure message.	A string that describes the success or error.	`Bind reloading on example using rndc zone: [example.tld] The subdomain "subdomain.example.com" has been removed.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`