Description

This function deletes an SSL certificate.


This function only deletes certificates from SSL storage. To end SSL coverage for a domain, use the UAPI function SSL::delete_ssl instead.


Examples




https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_cert?friendly_name=TestCert



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delete the TestCert certificate.
$SSL_delete_cert = $cpanel->uapi(
    'SSL', 'delete_cert',    array(
        'friendly_name'    => 'TestCert',
    )
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Delete the TestCert certificate.
my $SSL_delete_cert = $cpliveapi->uapi(
    'SSL', 'delete_cert',    {
        'friendly_name'    => 'TestCert',
    }
);



<!--  Delete the TestCert certificate. -->
[% data = execute( 'SSL', 'delete_cert', { friendly_name => 'TestCert'} ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]



uapi --user=username SSL delete_cert friendly_name=TestCert



{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "is_self_signed": "1",
      "validation_type":"dv",
      "signature_algorithm":"sha256WithRSAEncryption",
      "issuer.organizationName": "cPanel",
      "modulus": "a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db",",
      "subject.commonName": "example.com",
      "not_before": "1365713671",
      "modulus_length": "2048",
      "not_after": "1397249671",
      "created": "1365713671",
      "domains": [
        "example.com"
      ],
      "issuer.commonName": "example.com",
      "friendly_name": "TestCert",
      "id": "example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3"
    }
  ],
  "metadata": {
    "transformed": 1
  }
}



Parameters

You must include one of the following parameters:

ParameterTypeDescriptionPossible valuesExample
idstring

The certificate's ID.

A valid string.



example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3


 

 

friendly_namestringThe certificate's friendly name.A valid string.TestCert

Returns

ReturnTypeDescriptionPossible valuesExample
is_self_signed BooleanWhether the certificate is self-signed.
  • 1 — Self-signed.
  • 0 — Not self-signed.
1
              
validation_type
string

The certificate's validation type.

We introduced this return in cPanel & WHM version 56.


  • ev — Extended Validation.
  • ov — Organization Validation.
  • dv — Domain Validation.
  • undef — The system could not parse and determine the certificate's validation type.
dv

signature_algorithm

string

The signature algorithm of the certificate.

We introduced this return in cPanel & WHM version 56.


A valid OID hash algorithm name.
sha256WithRSAEncryption
issuer.organizationNamestringThe certificate's organization name.A valid string.Organization
modulusstringThe certificate's modulus.A valid string.


                        a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acdb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafabd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a3689f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f35342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed179973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd869ef9dddf 


subject.commonNamestringThe certificate's common name.A valid domain.
example.com

not_before

stringWhen the certificate started.A date in Unix time format.
1365713671
modulus_lengthstringThe length of the certificate's modulus.A positive integer.
2048
not_afterstringWhen the certificate expired.A date in Unix time format.
1397249671
createdstringWhen the certificate was created.A date in Unix time format.
1365713671
domainsarrayThe domains that the certificate covers.A valid domain or domains.
example.com
issuer.commonNamestringThe name that issued the certificate.Usually, a valid domain.
example.com
friendly_namestringThe certificate's friendly name.A valid string.
TestCert
idstringThe certificate's ID.A valid string.
example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3