Child pages
  • cPanel API 2 Functions - SubDomain::delsubdomain

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function deletes a subdomain.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Remove a subdomain.
$delsubdomain = $cpanel->api2(
    'SubDomain', 'delsubdomain', 
        array(
        'domain' => 'subdomain.example.com'
    )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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'
    } 

);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagetext
cpapi2 --user=username SubDomain delsubdomain domain=subdomain.example.com

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{ 
   "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"
   }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The name of the subdomain to delete.

A valid domain name.

 

subdomain.example.com

Note
titleNote:

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

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstring

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.
resultBoolean

Whether the function succeeded.

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