Description
This function removes a redirect from a domain.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mime/delete_redirect?domain%3Dexample.com%26src%3Dredirectpage.html%26docroot%3D%2Fhome%2Fexample%2Fpublic_html%2F
LiveAPI PHP Class
$cpanel
=
new
CPANEL();
$mime_delete_redirect
=
$cpanel
->uapi(
'Mime'
,
'delete_redirect'
,
array
(
'domain'
=>
'example.com'
,
'src'
=>
'redirectpage.html'
,
'docroot'
=>
'/home/example/public_html/'
,
)
);
LiveAPI Perl Module
my
$cpliveapi
= Cpanel::LiveAPI->new();
my
$mime_delete_redirect
=
$cpliveapi
->uapi(
'Mime'
,
'delete_redirect'
,
{
'domain'
=>
'example.com'
,
'src'
=>
'redirectpage.html'
,
'docroot'
=>
'/home/example/public_html/'
,
}
);
cPanel Template Toolkit
[% data = execute( 'Mime', 'delete_redirect', {'domain' => 'example.com', 'src' => 'redirectpage.html', 'docroot' => '/home/example/public_html/',} ); %]
Command Line
uapi --user=username Mime delete_redirect domain=example.com src=redirectpage.html docroot=%5C%2Fhome%5C%2Fexample%5C%2Fpublic_html%5C%2F
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"data": null
}
Parameters
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
domain
|
string
|
Required
The domain name.
|
A valid domain.
|
example.com
|
src
|
string
|
The specific page that redirects visitors.
|
A valid filename.
|
http://example.com/specific-page
|
redirect
|
string
|
Required
The document root that contains the .htaccess file to change.
|
An absolute file path.
|
/home/example/public_html/
|
Returns
This function only returns metadata.