cPanel API 2 Functions - AddonDomain::deladdondomain - Knowledgebase

Description

This function deletes an addon domain and its 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=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=AddonDomain&cpanel_jsonapi_func=deladdondomain&domain=addondomain.com&subdomain=addondomain_example.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Delete the "addondomain.com" addon domain.
$del_addon = $cpanel->api2(
    'AddonDomain', 'deladdondomain',
    array(
        'domain'         => 'addondomain.com',
        'subdomain'      => 'addondomain_example.com',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Delete the "addondomain.com" addon domain.
my $del_addon = $cpliveapi->api2(
    'AddonDomain', 'deladdondomain',
    {
        'domain'         => 'addondomain.com',
        'subdomain'      => 'addondomain_example.com',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "deladdondomain",
    "data": [
       
    ],
    "event": {
      "result": 1
    },
    "module": "AddonDomain"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	Required The addon domain name.	The addon domain's name.	addondomain.com
subdomain	string	Required The addon domain name and main domain to which the subdomain correspond.	The addon domain's username, an underscore (_), and the addon domain's main domain.	addondomain_example.com

Parameter

Type

Description

Possible values

Example

domain

string

Required

The addon domain name.

The addon domain's name.

addondomain.com

subdomain

string

Required

The addon domain name and main domain to which the subdomain correspond.

The addon domain's username, an underscore (_), and the addon domain's main domain.

addondomain_example.com

Returns

Return	Type	Description	Possible values	Example
reason	string	A reason for failure. Note: This function only returns a reason value if there was an error.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Return

Type

Description

Possible values

Example

reason

string

A reason for failure.

Note:

This function only returns a reason value if there was an error.

A string that describes the error.

This is an error message.

result

boolean

Whether the function succeeded.

1 — The function succeeded.
0 — The function failed.

Knowledgebase

Categories

Categories