You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • UAPI Functions - Mime::get_redirect
Skip to end of metadata
Go to start of metadata

Description

This function retrieves a redirection URL for a domain.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mime/get_redirect?domain=example.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.
 
// Retrieve a redirection URL for a domain.
$get_userdata = $cpanel->uapi(
    'Mime', 'get_redirect', 
        array(
        '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.
 
# Retrieve a redirection URL for a domain.
my $get_userdata = $cpliveapi->uapi(
    'Mime', 'get_redirect',
 	{
        'domain'                => 'example.com',
    } 
);


Note:

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

 Command Line
uapi --user=username Mime get_redirect 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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "errors":null,
   "messages":null,
   "status":1,
   "metadata":{  

   },
   "data":{
	   "redirection_enabled":"1",	 
       "url":"https://www.targetdomain.com"
   }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain's name.

A fully-qualified domain name (FQDN).

example.com

Returns

ReturnTypeDescriptionPossible valuesExample
redirection_enabled BooleanWhether the domain redirects to another URL.
  • 1 — Redirects.
  • 0 — Doesn't redirect.
1 
urlstring

The URL to which to the domain redirects.

A valid URL.http://www.domain.com