Child pages
  • UAPI Functions - SSL::can_ssl_redirect
Skip to end of metadata
Go to start of metadata

Description

This function determines whether the system can automatically redirect domains on a cPanel account to use SSL.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/can_ssl_redirect


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.
 
// Check whether the system can redirect user domains to use SSL.
$utf8_check = $cpanel->uapi(
    'SSL', 'can_ssl_redirect',
);


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.
 
# Check whether the system can redirect user domains to use SSL.
my $utf8-check = $cpliveapi->uapi(
    'SSL', 'can_ssl_redirect',
);


Note:

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

 Command Line
uapi --user=username SSL can_ssl_redirect


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)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": 1
}


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
dataBooleanWhether the system can automatically redirect the domains to use SSL.
  • 1 — Can redirect.
  • 0Cannot redirect.
1