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

Description

This function installs an SSL certificate.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$install_certificate = $cpanel->api1('SSL','install', array('example.com','CERTIFICATE','KEY','CAB') ); // 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 $install_certificate = $cpliveapi->api1('SSL','install', ['example.com','CERTIFICATE','KEY','CAB'] ); # 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::install( $FORM('domain','crt_data','key_data','cab_data') )">
 Command Line
cpapi1 --user=username SSL install example.com CERTIFICATE KEY CAB


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)
Your SSL certificate has been successfully installed to your site.

Parameters

ParameterTypeDescriptionPossible valuesExample
domain

string

Required

The domain name.

A valid domain name.example.com
crt_datastring

Required

The SSL certificate data.

A valid certificate.(The raw certificate data.)
key_datastring

Required

The SSL key data.

A valid SSL key.(The raw key data.)
cab_datastringThe Certificate Authority (CA) bundle data, if the certificate requires it.A valid CA bundle.(The raw CA bundle data.)

Returns

This function returns a confirmation message.