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

Description

This function retrieves a 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.
$set_certificate = $cpanel->api1('SSL','showcrt', array('TestCST', '0') ); // 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 $set_certificate = $cpliveapi->api1('SSL','showcrt', ['TestCRT', '0'] ); # 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::showcrt( $FORM('host', 'textmode') )">
 Command Line
cpapi1 --user=username SSL showcrt TestCRT 0


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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (HTML)

This function returns the contents of the certificate.

Parameters

ParameterTypeDescriptionPossible valuesExample
host

string

Required

The certificate's name.

Any valid string.TestCSR
textmodeBooleanWhether to display the certificate in human-readable format or the literal data.
  • 1 — Display in human-readable format.
  • 0 — Display the literal certificate data.
0

Returns

This function returns the certificate's contents.