cPanel API 2 Functions - SubDomain::delsubdomain - Knowledgebase

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=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SubDomain&cpanel_jsonapi_func=delsubdomain&domain=subdomain.example.com

 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'
    )
);

 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'
    }
 
);

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 ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

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

Notes:

You must URI-encode values.
username represents your account-level username.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	Required The subdomain name to delete.	A valid domain name.	subdomain.example.com

Parameter

Type

Description

Possible values

Example

domain

string

Required

The subdomain name to delete.

A valid domain name.

subdomain.example.com

Returns

Return	Type	Description	Possible values	Example
reason	string	A message of success or a reason for failure.	A string that describes the success or error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories