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

 

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

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.
 
// Share the certificate on the account.
$SSL_set_ssl_share = $cpanel->uapi(
    'SSL', 'set_ssl_share',    array(
        'enable'      => '1',
    )
);

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.
 
# Share the certificate on the account.
my $SSL_set_ssl_share = $cpliveapi->uapi(
    'SSL', 'set_ssl_share',    {
        'enable'     => '1',
    }
);

Note:

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

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

Note:

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

 Command Line
uapi --user=username SSL set_ssl_share enable=1

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": 1,
  "data": null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
enableBoolean

Required

Whether to share the account's certificate.

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

Returns

This function only returns metadata.