Child pages
  • cPanel API 1 Functions - SubDomain::disablesubrd

Versions Compared

Key

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

Description

Excerpt

This function disables a subdomain redirection.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$disable_subdomain = $cpanel->api1('SubDomain','disablesubrd', array('subdomain.example.com') ); // Call the function.

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.
my $disable_subdomain = $cpliveapi->api1('SubDomain','disablesubrd', ['subdomain.example.com'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="SubDomain::disablesubrd( $FORM('sub') )">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username SubDomain disablesubrd subdomain.example.com

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (HTML)
Code Block
languagexml
<b>Redirection has been disabled on $subdomain.</b>

   

Parameters

ParameterTypeDescriptionPossible valuesExample
sub

string

Required

The subdomain.

A valid subdomain string or a fully-qualified domain name.

subdomain.example.com

Returns

This function returns a confirmation message.