Child pages
  • UAPI Functions - Mime::add_redirect
Skip to end of metadata
Go to start of metadata

Description

This function adds a redirect to a domain.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mime/add_redirect?domain%3D.*%26src%3Dhttp%3A%2F%2Fexample.com%2Fspecific-page%26redirect%3Dhttp%3A%2F%2Fexample2.com%26redirect_wildcard%3D1%26redirect_www%3D0%26type%3Dpermanent


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
//   Add a redirect to the example.com domain
$mime_add_redirect = $cpanel->uapi(
    'Mime', 'add_redirect',
    array(
        'domain'            => 'example.com',
        'src'               => 'http://example.com/specific-page',
        'redirect'          => 'http://example.com/',
        'type'              => 'permanent',
        'redirect_wildcard' => '1',
        'redirect_www'      => '0',
 )
);


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.
 
#   Add a redirect to the example.com domain
my $mime_add_redirect = $cpliveapi->uapi(
    'Mime', 'add_redirect',
    {
        'domain'            => 'example.com',
        'src'               => 'http://example.com/specific-page',
        'redirect'          => 'http://example.com/',
        'type'              => 'permanent',
        'redirect_wildcard' => '1',
        'redirect_www'      => '0',
    }
);


Note:

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

 cPanel Template Toolkit
<!--  Add a redirect to the example.com domain. -->
[% data = execute( 'Mime', 'add_redirect', {'domain' => 'example.com', 'src' => 'http://example.com/specific-page','redirect' => 'http://example.com/', 'type' => 'permanent','redirect_wildcard' => '1','redirect_www' => '0',} ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Mime add_redirect domain=example.com src=http%3A%5C%2F%5C%2Fexample.com%5C%2Fspecified-page redirect=http%3A%2F%2Fexample.com%2F type=permanent redirect_wildcard=1 redirect_www=0


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain from which to redirect.

A valid domain.

 

example.com
src
stringA specific page from which to redirect.A valid URL.
http://example.com/specific-page
redirect
string

Required

The URL to which to redirect.

A valid URL.
http://example.com/
type
string

Required

Whether the redirect is temporary.

  • permanent
  • temporary
permanent
redirect_wildcard
Boolean

Whether to include all of the domain's subdomains.

This value defaults to 0.

  • 1 — Include the domain's subdomains.
  • 0 — Do not include the domain's subdomains.
1
redirect_www
integer

Whether to redirect domains with or without www.

This value defaults to 0.

 

  • 2 — Redirect with www.
  • 1 — Redirect without www.
  • 0 — Redirect with and without www.
0

Returns

This function only returns metadata.