Child pages
  • UAPI Functions - SSL::check_shared_cert

Versions Compared

Key

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

Description

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


Warning
titleWarning:

We removed this function in cPanel & WHM version 76.


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/SSL/check_shared_cert

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


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

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

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


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

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagetext
uapi --user=username SSL check_shared_cert

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 0,
  "metadata": {
    
  },
  "data": null
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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