v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

SSL

SSL Certificate Management

Update certificate signing request's friendly name

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

Important:

You must call either the friendly_name or id parameter.
When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

get/SSL/set_csr_friendly_name

friendly_namestring required

Example:TestCSR

The CSR's friendly name.

idstring required

Example:example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18

The CSR's ID.

Note:

To retrieve a CSR's ID, use the UAPI list_csrs function.

new_friendly_namestring required

Example:TestCSR2

The CSR's new friendly name.

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

{
  "apiversion": 3,
  "func": "set_csr_friendly_name",
  "module": "SSL",
  "result": {
    "status": 1
  }
}