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

 

Description

This function checks whether a shared SSL certificate is associated with the account.

Examples 


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

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 a shared SSL certificate is associated with the account.
$SSL_check_shared_cert = $cpanel->uapi(
    'SSL', 'check_shared_cert'
);

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 a shared SSL certificate is associated with the account.
my $SSL_check_shared_cert = $cpliveapi->uapi(
    'SSL', 'check_shared_cert',
);

Note:

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

 cPanel Template Toolkit
<!-- Check whether a shared SSL certificate is associated with the account. -->
[% data = execute( 'SSL', 'check_shared_cert', ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Note:

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

 Command Line
uapi --user=username SSL check_shared_cert

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": 0,
  "metadata": {
    
  },
  "data": null
}


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
status BooleanWhether a shared SSL certificate is associated with the account.
  • 1 — Associated.
  • 0 — Not associated.
0