UAPI Functions - Mime::delete_redirect

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

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

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

 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.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null
}

 

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

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.

  • 14 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....