Description
This function changes a key's friendly name.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/set_key_friendly_name?friendly_name=TestKey&new_friendly_name=TestKey2
LiveAPI PHP Class
$cpanel = new CPANEL();
$SSL_set_key_friendly_name = $cpanel->uapi(
'SSL', 'set_key_friendly_name', array(
'friendly_name' => 'TestKey',
'new_friendly_name' => 'TestKey2',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $SSL_set_key_friendly_name = $cpliveapi->uapi(
'SSL', 'set_key_friendly_name', {
'friendly_name' => 'TestKey',
'new_friendly_name' => 'TestKey2',
}
);
cPanel Template Toolkit
[% data = execute( 'SSL', 'set_key_friendly_name', { friendly_name => 'TestKey', new_friendly_name => 'TestKey2'} ); %]
Command Line
uapi --user=username SSL set_key_friendly_name friendly_name=TestKey new_friendly_name=TestKey2
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"data": null
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
friendly_name
|
string
|
Required
The key's friendly name.
|
A valid string.
|
TestKey
|
|
new_friendly_name
|
string
|
Required
The key's new friendly name.
|
A valid string.
|
TestKey2
|
Returns
This function only returns metadata.
