Delete certificate signing request

This function deletes a certificate signing request (CSR).

Note:

  • When you call this function, you must include the id or the friendly_name parameter.
  • To delete a private key, use the UAPI SSL::delete_key function instead.

Important:

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
string

The CSR's friendly name.

Example: friendly_name=TestCSR
id
string

The CSR's ID.

Example: id=example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f

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

uapi --output=jsonpretty \
  --user=username \
  SSL \
  delete_csr

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "delete_csr",
  • "module": "SSL",
  • "result": {
    • "data": [
      • {
        • "commonName": "example.com",
        • "created": 1538308800,
        • "domains": [
          • "example.com"
          ],
        • "ecdsa_curve_name": null,
        • "ecdsa_public": null,
        • "friendly_name": "TestCSR",
        • "id": "example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f",
        • "key_algorithm": "rsaEncryption",
        • "modulus": "a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acd\nb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafab\nd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a368\n9f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f3\n5342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed1\n79973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc\n285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e\n6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd86\n9ef9dddf"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}