Description
This function retrieves certificate signing requests (CSR) for a private key.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/find_csrs_for_key?friendly_name=TestKey
LiveAPI PHP Class
$cpanel = new CPANEL();
$SSL_find_csrs_for_key = $cpanel->uapi(
'SSL', 'find_csrs_for_key', array(
'friendly_name' => 'TestKey',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $SSL_find_csrs_for_key = $cpliveapi->uapi(
'SSL', 'find_csrs_for_key', {
'friendly_name' => 'TestKey',
}
);
cPanel Template Toolkit
[% data = execute( 'SSL', 'find_csrs_for_key', { friendly_name => 'TestKey'} ); %]
[% FOREACH q = data %]
<p>
[% q %]
</p>
[% END %]
Command Line
uapi --user=username SSL find_csrs_for_key friendly_name=TestKey
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"metadata": {
"transformed": 1
},
"data": [
{
"created": "1402332791",
"domains": [
"example.com"
],
"commonName": "example.com",
"modulus": "a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acdb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafabd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a3689f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f35342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed179973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd869ef9dddf",
"id": "example_com_a74f7_9dddf_2c5d1615e85db817d6b640f65335fb62",
"friendly_name": "TestCSR"
}
]
}
Parameters
You must include one of the following parameters:
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
id
|
string
|
The key's ID.
|
A valid string.
|
example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3
|
|
friendly_name
|
string
|
The key's friendly name.
|
A valid string.
|
TestKey
|
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
created
|
string
|
When the CSR was created.
|
A valid date in Unix time format.
|
1402332791
|
|
domains
|
string
|
The domains that the CSR covers.
|
A valid domain or domains.
|
example.com
|
|
commonName
|
string
|
The CSR's common name.
|
A valid domain.
|
example.com
|
|
modulus
|
string
|
The CSR's modulus.
|
A valid string.
|
|
|
id
|
string
|
The CSR's ID.
|
A valid string.
|
|
|
friendly_name
|
string
|
The CSR's friendly name.
|
A valid string.
|
TestCSR
|
