UAPI Functions - SSL::delete_cert

Description

This function deletes an SSL certificate.

Examples


 cPanel or Webmail Session URL

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

 LiveAPI PHP Class

$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',
    )
);

 LiveAPI Perl Module

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',
    }
);

 cPanel Template Toolkit

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

 Command Line

uapi --user=username SSL delete_cert friendly_name=TestCert

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

{
  "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
  }
}

 

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

You must include one of the following parameters:

Parameter

Type

Description

 Possible values 

 Example 

id

string

The certificate's ID.

A valid string.

 

 friendly_name 

 string 

 The certificate's friendly name. 

A valid string.

TestCert

 

Returns

Return

Type

Description

Possible values

Example

is_self_signed

 Boolean 

Whether the certificate is self-signed.

  • 1 — Self-signed.
  • 0 — Not self-signed.

1

             

validation_type

string

The certificate's validation type.

Note:

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.

Note:

 We introduced this return in cPanel & WHM version 56. 

A valid OID hash algorithm name.

sha256WithRSAEncryption

 issuer.organizationName 

string

The certificate's organization name.

A valid string.

Organization

modulus

string

The certificate's modulus.

A valid string.

 Click to view...

subject.commonName

string

The certificate's common name.

A valid domain.

example.com

not_before

string

When the certificate started.

A date in Unix time format.

1365713671

modulus_length

string

The length of the certificate's modulus.

A positive integer.

2048

not_after

string

When the certificate expired.

A date in Unix time format.

1397249671

created

string

When the certificate was created.

A date in Unix time format.

1365713671

domains

array

The domains that the certificate covers.

A valid domain or domains.

example.com

issuer.commonName

string

The name that issued the certificate.

Usually, a valid domain.

example.com

friendly_name

string

The certificate's friendly name.

A valid string.

TestCert

id

string

The certificate's ID.

A valid string.

 example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3 

 

  • 7 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....