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.

Authorizations:

query Parameters

friendly_name required	string The key's friendly name. Example: friendly_name=TestKey
id required	string The key's ID. Example: id=a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d
new_friendly_name required	string The key's new friendly name. Example: new_friendly_name=TestKey2

Responses

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  SSL \
  set_key_friendly_name \
  friendly_name='TestKey' \
  id='a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d' \
  new_friendly_name='TestKey2'

Response samples

Content type

application/json

{"apiversion": 3,
"func": "set_key_friendly_name",
"module": "SSL",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}

Next to Update SSL website for dedicated IP address