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

Description

This function redirects a parked domain (alias) 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.
$set_redirect = $cpanel->api1('Park','setredirecturl', array('example.com','http://www.targetdomain.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 $set_redirect = $cpliveapi->api1('Park','setredirecturl', ['example.com','http://www.targetdomain.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="Park::setredirecturl( $FORM('domain','topdomain') )">
 Command Line
cpapi1 --user=username Park setredirecturl example.com http://www.targetdomain.com


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (plaintext)
http://www.example.com

Parameters

ParameterTypeDescriptionPossible valuesExample
domain

string

Required

The parked domain.

A valid domain name.example.com
topdomainstring

Required

The target URL to which to redirect the domain.

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

Returns

This function returns the target URL as a confirmation message.