Child pages
  • cPanel API 1 Functions - SubDomain::setsuburl
Skip to end of metadata
Go to start of metadata

Description

This function redirects a subdomain to a URL.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples 


 LiveAPI PHP Class
$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.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
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.


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="SubDomain::setsuburl( $FORM('sub','url') )">
 Command Line
cpapi1 --user=username SubDomain setsuburl subdomain http://www.example.com


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

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