Description

This function changes a certificate's friendly name.

Examples 


https://hostname.example.com:2083/cpsess##########/execute/SSL/set_cert_friendly_name?friendly_name=TestCert&new_friendly_name=TestCert2

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Change friendly name "TestCert" to "TestCert2"
$SSL_set_cert_friendly_name = $cpanel->uapi(
    'SSL', 'set_cert_friendly_name',    array(
        'friendly_name'      => 'TestCert',
        'new_friendly_name'  => 'TestCert2',
    )
);

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
#  Change friendly name "TestCert" to "TestCert2"
my $SSL_set_cert_friendly_name = $cpliveapi->uapi(
    'SSL', 'set_cert_friendly_name',    {
        'friendly_name'     => 'TestCert',
        'new_friendly_name' => 'TestCert2',
    }
);

<!-- Change friendly name "TestCert" to "TestCert2" -->
[% data = execute( 'SSL', 'set_cert_friendly_name', { friendly_name => 'TestCert', new_friendly_name => 'TestCert2'} ); %]

uapi --user=username SSL set_cert_friendly_name friendly_name=TestCert new_friendly_name=TestCert2

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null
}

Parameters

ParameterTypeDescriptionPossible valuesExample
friendly_namestring

Required

The certificate's friendly name.

A valid string.
TestCert
new_friendly_namestring

Required

The certificate's new friendly name.

A valid string.
TestCert2

Returns

This function only returns metadata.