Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function changes a certificate signing request's (CSR) friendly name.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/set_csr_friendly_name?friendly_name=TestCSR&new_friendly_name=TestCSR2

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 "TestCSR" to "TestCSR2"
$SSL_set_csr_friendly_name = $cpanel->uapi(
    'SSL', 'set_csr_friendly_name',    array(
        'friendly_name'      => 'TestCSR',
        'new_friendly_name'  => 'TestCSR2',
    )
);

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 "TestCSR" to "TestCSR2"
my $SSL_set_csr_friendly_name = $cpliveapi->uapi(
    'SSL', 'set_csr_friendly_name',    {
        'friendly_name'     => 'TestCSR',
        'new_friendly_name' => 'TestCSR2',
    }
);

Note:

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

 cPanel Template Toolkit
<!-- Change friendly name "TestCSR" to "TestCSR2" -->
[% data = execute( 'SSL', 'set_csr_friendly_name', { friendly_name => 'TestCSR', new_friendly_name => 'TestCSR2'} ); %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username SSL ser_csr_friendly_name friendly_name=TestCSR new_friendly_name=TestCSR2

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 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_namestring

Required

The CSR's friendly name.

A valid string.
TestCSR
new_friendly_namestring

Required

The CSR's new friendly name.

A valid string.
TestCSR2

Returns

This function only returns metadata.