UAPI Functions - SSL::set_ssl_share

Description

This function shares and unshares the account's SSL certificate.

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/SSL/set_ssl_share?enable=1

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Share the certificate on the account.
$SSL_set_ssl_share $cpanel->uapi(
    'SSL''set_ssl_share',    array(
        'enable'      => '1',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Share the certificate on the account.
my $SSL_set_ssl_share $cpliveapi->uapi(
    'SSL''set_ssl_share',    {
        'enable'     => '1',
    }
);

 cPanel Template Toolkit

<!--  Share the certificate on the account. -->
[% data = execute( 'SSL', 'set_ssl_share', { enable => '1',} ); %]

 Command Line

uapi --user=username SSL set_ssl_share enable=1

 

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null
}

 

Note:

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

 

Parameters

 Parameter 

Type

Description

Possible values

 Example 

enable

 Boolean 

Required

 Whether to share the account's certificate. 

  • 1 — Share.
  • 0 — Do not share. 

1

 

Returns

This function only returns metadata.

  • 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....