UAPI Functions - Mime::redirect_info - Knowledgebase

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

[% 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

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

Knowledgebase

Categories

Categories