UAPI Functions - Mime::redirect_info

Description

This function retrieves redirect information for a URL or ** All Public Domains **.

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mime/redirect_info?url%3Dhttp%3A%2F%2Fredirect.example.com%26domain%3Dexample.com


 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// List redirection info
$mime_redirect_info $cpanel->uapi(
    'Mime''redirect_info',    array(
        'url'    => 'http://redirect.example.com',
        'domain' => 'example.com',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List redirection info
my $mime_redirect_info $cpliveapi->uapi(
    'Mime''redirect_info',    {
        'url'    => 'http://redirect.example.com',
        'domain' => 'example.com',
    }
);

 cPanel Template Toolkit

<!--  List redirection info -->
[% data = execute( 'Mime', 'redirect_info', { url => 'http://redirect.example.com', domain => 'example.com'} ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

 Command Line

uapi --user=username Mime redirect_info url=http%3A%2F%2Fredirect.example.com domain=example.com 

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

 

{

 

  "messages": null,

 

  "errors": null,

 

  "status": 1,

 

  "data": {

 

    "domain": "example.com\n",

 

    "url": "http://redirect.example.com\n"

 

  }

 

}

Note:

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

 

Parameters

 Parameter 

Type

Description

 Possible values 

Example

url

 string 

Required

The URL for which to retrieve redirector information.

A valid URL.

 http://redirect.example.com 

domain

string

Required

 The domain for which to retrieve redirector information. 

A valid domain.

example.com

 

Returns

 Return 

Type

Description

Possible values

Example

url

 string 

The redirect's URL.

A valid URL.

 http://redirect.example.com 

domain

string

 The redirect's domain, or ** All Public Domains **. 

  • A valid domain.
  • ** All Public Domains ** 

example.com

 

  • 0 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....