Child pages
  • cPanel API 1 Functions - SSL::showkey

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function retrieves a key.

Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)SSL::show_key
    Excerpt Include
    UAPI Functions - SSL::show_key
    UAPI Functions - SSL::show_key
    nopaneltrue
  • cPanel API 2None.
Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$ssl_key = $cpanel->api1('SSL','showkey', array('TestKEY', '0') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

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

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="SSL::showkey( $FORM('host','textmode') )">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username SSL showkey TestKey 0

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (plaintext)

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.