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

Description

This function retrieves the hostname and CA (Certificate Authority) bundle for a domain and 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.
$ca_bundle = $cpanel->api1('SSL','getcabundle', array('example.com','CERTIFICATE') ); // 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 $ca_bundle = $cpliveapi->api1('SSL','getcabundle', ['example.com','CERTIFICATE'] ); # 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::getcabundle( $FORM('domain','crt') )">
 Command Line
cpapi1 --user=username SSL getcabundle example.com CERTIFICATE


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)
GET DOMAIN: example.com
BUNDLE: (The text of the certificate bundle) 

Parameters

ParameterTypeDescriptionPossible valuesExample
domain

string

Required

The domain name.

A valid domain name.example.com
crtstring

Required

The certificate data.

The raw text of the certificate.(The text of the certificate bundle.)

Returns

This function returns the domain name and the raw CA bundle.