Description

This function disables a subdomain redirection.

Examples 


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$disable_subdomain = $cpanel->api1('SubDomain','disablesubrd', array('subdomain.example.com') ); // Call the function.

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.

 

<cpanel Module="SubDomain::disablesubrd( $FORM('sub') )">
cpapi1 --user=username SubDomain disablesubrd subdomain.example.com

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