Description

This function adds a redirect to a domain.

Examples 




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



$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',
 )
);



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',
    }
);



<!--  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',} ); %]



uapi --user=username Mime add_redirect domain=example.com src=http://example.com/specified-page redirect=http://example.com type=permanent redirect_wildcard=1 redirect_www=0



{  
   "status":1,
   "warnings":null,
   "errors":null,
   "metadata":{  

   },
   "messages":[  
      "Htaccess Installed"
   ],
   "data":null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain from which to redirect.

A valid domain.

 

example.com
src
string

A specific page from which to redirect.

This value defaults to the domain parameter's value.

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 redirect all files within a directory to the same filename within the destination directory.

This value defaults to 0.

  • 1 — Redirect all files within the directory.
  • 0 — Do not redirect all files within the directory.
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.