Child pages
  • UAPI Functions - Mime::redirect_info

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

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

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


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

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
    )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


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

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


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

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "domain": "example.com\n",
    "url": "http://redirect.example.com\n"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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