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

Description


This function retrieves a certificate signing request (CSR).

Warning:

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

  • UAPI (recommended)SSL::show_csr
    Error rendering macro 'excerpt-include' : No link could be created for 'UAPI Functions - SSL::show_csr'.
  • cPanel API 2None.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$set_csr = $cpanel->api1('SSL','showcsr', array('TestCSR', '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_csr = $cpliveapi->api1('SSL','showcsr', ['TestCSR', '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::showcsr( $FORM('host','textmode') )">
 Command Line
cpapi1 --user=username SSL showcsr TestCSR 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.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (plaintext)

This function returns the contents of the CSR.

Parameters

ParameterTypeDescriptionPossible valuesExample
host

string

Required

The CSR's name.

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

Returns

This function displays the CSR's contents.