UAPI Functions - SSL::delete_key

Description

This function deletes a private key.

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_key?friendly_name=TestKey

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Remove the private key TestKey
$SSL_delete_key $cpanel->uapi(
    'SSL''delete_key',    array(
        'friendly_name'    => 'TestKey',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# TEMPLATE
my $SSL_delete_key $cpliveapi->uapi(
    'SSL''delete_key',    {
        'friendly_name'    => 'TestKey',
    }
);

 cPanel Template Toolkit

<!--  List redirection info -->
[% data = execute( 'SSL', 'delete_key', { friendly_name => 'TestKey',} ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

 Command Line

uapi --user=username SSL delete_key friendlyname=TestCSR

 

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "created": "1365715090",
      "modulus": "a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db",
      "friendly_name": "TestKey",
      "modulus_length": "2048"
    }
  ],
  "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 private key's ID.

A valid string.

 

 friendly_name 

 string 

 The private key's friendly name. 

A valid string.

TestKey

 

Returns

Return

Type

Description

Possible values

Example

created

string

The private key's creation date.

 A date in Unix time format. 

 1365715090 

modulus

string

The private key's modulus.

A valid string.

 

 modulus_length 

 integer 

The modulus length, in bits.

A valid string.

2048

friendly_name

string

 The private key's friendly name. 

A valid string.

TestCSR

 

 

  • 0 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....