Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
SSL
SSL Certificate Management

Update private key's friendly name

This function changes a key's 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_key_friendly_name

Query parameters

friendly_namestring required
Example:TestKey

The key's friendly name.

idstring required
Example:a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d

The key's ID.

new_friendly_namestring required
Example:TestKey2

The key's new friendly name.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

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