You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • UAPI Functions - SSL::delete_key
Skip to end of metadata
Go to start of metadata

Description

This function deletes a private key.

Note:

To delete a certificate signing request (CSR), use the UAPI function SSL::delete_csr instead.

Important:

In cPanel & WHM version 84 and later, when you disable the Calendars and Contacts, Receive MailWeb DiskWebmail, and Web Server roles, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_key?friendly_name=TestKey


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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


Note:

For more information, read our Guide to the LiveAPI System.

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


Note:

For more information, read our Guide to the LiveAPI System.

 Command Line
uapi --user=username SSL delete_key friendlyname=TestCSR


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "apiversion": 3,
  "func": "delete_key",
  "module": "SSL",
  "result": {
    "data": [
      {
        "created": "1365715090",
        "friendly_name": "TestCSR",
        "key_algorithm": "rsaEncryption",
        "modulus": "a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db",
        "modulus_length": 2048,
        "ecdsa_curve_name": null,
        "ecdsa_public": null
      }
    ],
    "errors": null,
    


Note:

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

Parameters

 You must include one of the following parameters:

ParameterTypeDescriptionPossible valuesExample
idstring

The private key's ID.

A valid string.
 Click to view...
example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f



friendly_namestringThe private key's friendly name.A valid string.TestKey

Returns

ReturnTypeDescriptionPossible valuesExample
created stringThe private key's creation date.A date in Unix time format.
1365715090
modulusstringThe private key's modulus.
  • A valid string.
  • null — The key is not an RSA key.

Note:

We added the null value in cPanel & WHM version 92.

 Click to view...
a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acdb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafabd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a3689f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f35342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed179973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd869ef9dddf
modulus_lengthintegerThe modulus length, in bits.
  • A positive integer.
  • null — The certificate's key is not an RSA key.

Note:

We added the null value in cPanel & WHM version 92.

2048
friendly_namestringThe private key's friendly name.A valid string.TestCSR
key_algorithmstring

The key's algorithm.

Note:

We added this return in cPanel & WHM version 92.

  • rsaEncryption — RSA.
  • id-ecPublicKey — ECDSA.
rsaEncryption
ecdsa_curve_namestring

The ECDSA curve that the key uses.

Note:

We added this return in cPanel & WHM version 92.

  • prime256v1
  • secp384r1
  • null — The certificate's key is not an ECDSA key.
prime256v1
ecdsa_publicstring

The key's ECDSA compressed public point, in hexadecimal format.

Note:

We added this return in cPanel & WHM version 92.

  • A valid string.
  • null — The certificate's key is not an ECDSA key.
02a2cb73408a5833ffbe6eedac9227b9985c54a94990cc4a13ea2a57f3bdecada1