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

Versions Compared

Key

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

Description

Excerpt

This function redirects a subdomain to a URL.

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.
$enable_redirect = $cpanel->api1('SubDomain','setsuburl', array('subdomain','http://www.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 $enable_redirect = $cpliveapi->api1('SubDomain','setsuburl', ['subdomain','http://www.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::setsuburl( $FORM('sub','url') )">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username SubDomain setsuburl subdomain http://www.example.com

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (none)
This function does not return output.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
sub

string

Required

The subdomain to redirect.

A valid subdomain string.

subdomain


urlstring

Required

The URL to which to redirect the subdomain.

A valid URL.http://www.example.com

Returns

This function does not return output.