UAPI Functions - SSL::set_cert_friendly_name

Description

This function changes a certificate's friendly name.

Examples 


 cPanel or Webmail Session URL

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

 LiveAPI PHP Class

$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',
    )
);

 LiveAPI Perl Module

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',
    }
);

 cPanel Template Toolkit

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

 Command Line

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

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

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

 

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

Parameter

Type

Description

 Possible values 

 Example 

friendly_name

 string 

Required

The certificate's friendly name.

A valid string.

TestCert

 new_friendly_name 

 string 

Required

 The certificate's new friendly name. 

A valid string.

TestCert2

 

Returns

This function only returns metadata.

  • 7 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....