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

Description

This function removes a redirect from 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/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. 
  • 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 name.

A valid domain.

 

example.com
redirect
string

Required

The document root that contains the .htaccess file to change.

An absolute file path.
/home/example/public_html/
src
string

The specific page that redirects visitors.

This parameter defaults to an empty string.

A valid filename.
http://example.com/specific-page
args
string

An argument string that contains the arguments of a Redirect or RedirectMatchdirectives.

This parameter defaults to an empty string.

A valid argument string for a Redirect or RedirectMatchdirective.
                redirectme 
                http://redirectme.com/
              

Returns

This function only returns metadata.