Description
This function lists the types of the account's installed SSL items.
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=listsslitems&domains=
LiveAPI PHP Class
$cpanel = new CPANEL();
$list_ssl_item_types = $cpanel->api2(
'SSL', 'listsslitems',
array(
'domains' => 'example.com|seconddomain.com',
'items' => 'key|crt|csr',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $list_ssl_item_types = $cpliveapi->api2(
'SSL', 'listsslitems',
{
'domains' => 'example.com|seconddomain.com',
'items' => 'key|crt|csr',
}
);
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 listsslitems domains=example.com%7Cseconddomain.com items=key%7Ccrt%7Ccsr
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "listsslitems",
"data": [
{
"type": "key",
"host": "example.com"
},
{
"type": "crt",
"host": "example.com"
},
{
"type": "csr",
"host": "example.com"
},
{
"type": "key",
"host": "seconddomain.com"
}
],
"event": {
"result": 1
},
"module": "SSL"
}
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
domains
|
string
|
Required
The domain names.
|
One or more valid domain names.
Notes:
- Separate multiple domains with the pipe character (|).
- In WHM API calls, replace each pipe character with %7C.
|
example.com|seconddomain.com
|
|
items
|
string
|
Required
The SSL item types.
|
- key — Search for installed keys.
- crt — Search for installed certificates.
- csr — Search for installed Certificate Signing Requests (CSRs).
Notes:
- Separate multiple types with the pipe character ( | ).
- In WHM API calls, replace each pipe character with %7C.
|
key|crt|csr
|
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
type
|
string
|
The SSL item type.
|
- key — The domain has at least one key installed.
- crt — The domain has at least one certificate installed.
- csr — The domain has at least one CSR installed.
|
key
|
|
host
|
string
|
The domain on which the SSL items are present.
|
A domain that you specified in thedomains parameter.
|
example.com
|
|
reason
|
string
|
A reason for failure.
Note:
This function only returns a reason value if there was an error.
|
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
|
