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.

SecurityBasicAuth

Request

query Parameters

friendly_name required	string The CSR's friendly name. Example: friendly_name=TestCSR
id required	string The CSR's ID. Note: To retrieve a CSR's ID, use the UAPI `list_csrs` function. Example: id=example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18
new_friendly_name required	string The CSR's new friendly name. Example: new_friendly_name=TestCSR2

Responses

200

HTTP Request was successful.

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

get/SSL/set_csr_friendly_name

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  SSL \
  set_csr_friendly_name \
  friendly_name='TestCSR' \
  id='example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18' \
  new_friendly_name='TestCSR2'

Response samples

application/json

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