Page tree
Skip to end of metadata
Go to start of metadata

 

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

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.
 
// List redirection info
$mime_redirect_info = $cpanel->uapi(
    'Mime', 'redirect_info',    array(
        'url'    => 'http://redirect.example.com',
        'domain' => 'example.com',
    )
);

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.
 
# List redirection info
my $mime_redirect_info = $cpliveapi->uapi(
    'Mime', 'redirect_info',    {
        'url'    => 'http://redirect.example.com',
        'domain' => 'example.com',
    }
);

Note:

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

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

Note:

For more information, read our Guide to Template Toolkit documentation. 

 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.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
urlstring

Required

The URL for which to retrieve redirector information.

A valid URL.
http://redirect.example.com
domainstring

Required

The domain for which to retrieve redirector information.

A valid domain.example.com

Returns

ReturnTypeDescriptionPossible valuesExample
url stringThe redirect's URL.A valid URL.
http://redirect.example.com
domain stringThe redirect's domain, or ** All Public Domains **.
  • A valid domain.
  • ** All Public Domains **
example.com