v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

SSL

SSL Certificate Management

Delete SSL certificate

This function deletes an SSL certificate.

Note:

When you call this function, you must include the id or the friendly_name parameter.
This function only deletes certificates from SSL storage. To end SSL coverage for a domain, use the UAPI SSL::delete_ssl function instead.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

get/SSL/delete_cert

Query parameters

friendly_namestring

Example:TestCert

The certificate's friendly name.

idstring

Example:example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3

The certificate's ID.

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": "delete_cert",
  "module": "SSL",
  "result": {
    "data": [
      {
        "created": 1538308800,
        "domains": [
          "example.com"
        ],
        "ecdsa_curve_name": "prime256v1",
        "friendly_name": "TestCert",
        "id": "example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3",
        "is_self_signed": 1,
        "issuer.commonName": "example.com",
        "issuer.organizationName": "Organization",
        "issuer_text": "countryName\nUS\nstateOrProvinceName\nTX\nlocalityName\nHouston\norganizationName\nOrganization\ncommonName\nexample.com",
        "key_algorithm": "rsaEncryption",
        "modulus": "a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db",
        "modulus_length": 2048,
        "not_after": 1569844800,
        "not_before": 1538308800,
        "serial": "45462cd0d6537b20cf2f3eb8aec07140",
        "signature_algorithm": "sha256WithRSAEncryption",
        "subject.commonName": "example.com",
        "subject_text": "commonName\nwww.example.com",
        "validation_type": "dv"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}