Page tree
Skip to end of metadata
Go to start of metadata

 

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

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.
 
//   Remove a redirect from the example.com domain
$mime_delete_redirect = $cpanel->uapi(
    'Mime', 'delete_redirect',
    array(
        'domain'            => 'example.com',
        'src'               => 'redirectpage.html',
        'docroot'           => '/home/example/public_html/',
 )
);

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.
 
#  Remove a redirect from the example.com domain
my $mime_delete_redirect = $cpliveapi->uapi(
    'Mime', 'delete_redirect',
    {
        'domain'            => 'example.com',
        'src'               => 'redirectpage.html',
        'docroot'           => '/home/example/public_html/',
    }
);

Note:

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

 cPanel Template Toolkit
<!--   Remove a redirect from the example.com domain-->
[% data = execute( 'Mime', 'delete_redirect', {'domain' => 'example.com', 'src' => 'redirectpage.html', 'docroot' => '/home/example/public_html/',} ); %]

Note:

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

 Command Line
uapi --user=username Mime delete_redirect domain=example.com src=redirectpage.html docroot=%5C%2Fhome%5C%2Fexample%5C%2Fpublic_html%5C%2F

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 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 name.

A valid domain.

 

example.com
src
stringThe 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.