Description
This function lists the account's SSL keys.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SSL&cpanel_jsonapi_func=listkeys
LiveAPI PHP Class
$cpanel = new CPANEL();
$list_keys = $cpanel->api2(
'SSL', 'listkeys'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $list_keys = $cpliveapi->api2(
'SSL', 'listkeys',
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.
cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
Command Line
cpapi2 --user=username SSL listkeys
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "listkeys",
"data": [
{
"host": "example.com"
}
],
"event": {
"result": 1
},
"module": "SSL"
}
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
host
|
string
|
A domain for which a key exists.
|
A domain on the cPanel account.
|
example.com
|
|
reason
|
string
|
A reason for failure.
|
A string that describes the error.
|
This is an error message.
|
|
result
|
Boolean
|
Whether the function succeeded.
|
- 1 — The function succeeded.
- 0 — The function failed.
|
1
|
