Description

This function retrieves a key.

Examples 


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$ssl_key = $cpanel->api1('SSL','showkey', array('TestKEY', '0') ); // Call the function.

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $ssl_key = $cpliveapi->api1('SSL','showkey', ['TestKEY', '0'] ); # Call the function.

<cpanel Module="SSL::showkey( $FORM('host','textmode') )">
cpapi1 --user=username SSL showkey TestKey 0

This function returns the contents of the key.

Parameters

ParameterTypeDescriptionPossible valuesExample
host

string

Required

The key name.

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

Returns

This function returns the key's contents.