Child pages
  • cPanel API 1 Functions - SSL::sslsharedstatus
Skip to end of metadata
Go to start of metadata

Description

This function displays whether the account uses a shared SSL certificate.

Warning:

  • We removed this function in cPanel & WHM version 76.
  • cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:
  • UAPI (recommended)SSL::check_shared_cert — This function checks whether a shared SSL certificate is associated with the account.
  • cPanel API 2 None.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$ssl_shared_status = $cpanel->api1('SSL','sslsharedstatus'); // Call the function.


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.
my $ssl_shared_status = $cpliveapi->api1('SSL','sslsharedstatus'); # Call the function.


Note:

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

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="SSL::sslsharedstatus()">
 Command Line
cpapi1 --user=username SSL sslsharedstatus


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (plaintext)
true

Parameters

This function does not accept parameters.

Returns

  • true — The account has a shared certificate.
  • false — The account does not have a shared certificate.