Child pages
  • cPanel API 1 Functions - Mime::del_redirect
Skip to end of metadata
Go to start of metadata

Description

This function removes a redirect from an account's .htaccess file.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Important:

In cPanel & WHM version 76, the WebServer role affects this function.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$del_redirect = $cpanel->api1('Mime', 'del_redirect', array('directory/redirect-me','example.com','/home/user/public_html/example.com') ); // Call the function.


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.
my $del_redirect = $cpliveapi->api1('Mime', 'del_redirect', ['directory/redirect-me','example.com','/home/user/public_html/example.com'] ); # Call the function.


Note:

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

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Mime::del_redirect( $FORM('src','domain','docroot') )">
 Command Line
cpapi1 --user=username Mime del_redirect directory/redirect-me example.com public_html/example.com


Notes:

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

    /usr/local/cpanel/bin/api/cpapi1

 Output (none)

This function does not return output.

Parameters

ParameterTypeDescriptionPossible ValuesExample
src
string

Required

The page from which to remove the redirector, without the domain.

A valid file path.
directory/redirect-me
domainstring

Required

The redirector's domain.

Any valid file extension.
example.com
docrootstring

Required

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

A valid file path, relative to the user's home directory.public_html/example.com

Returns

This function does not return output.