UAPI Functions - SSL::check_shared_cert

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

 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'
);

 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',
);

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

 Command Line

uapi --user=username SSL check_shared_cert

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 0,
  "metadata": {
     
  },
  "data": null
}

 

Note:

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

 

Parameters

This function does not accept parameters.

Returns

 Return 

Type

Description

Possible values

 Example 

status

 Boolean 

 Whether a shared SSL certificate is associated with the account. 

  • 1 — Associated.
  • 0 — Not associated. 

0

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....