We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - SSL::set_cert_friendly_name
Skip to end of metadata
Go to start of metadata

Description

This function changes a certificate's friendly name.

Important:

In cPanel & WHM version 84 and later, when you disable the Calendars and Contacts, Receive Mail, Web DiskWebmail, and Web Server roles, the system disables this function.

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


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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


Note:

For more information, read our Guide to the LiveAPI System.

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


Note:

For more information, read our Guide to the LiveAPI System.

 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.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample

friendly_name

or

id

string

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.