We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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


This function lists an account's private keys.


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


 cPanel or Webmail Session URL


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.
// List an account's keys.
$SSL_list_keys = $cpanel->uapi(
    'SSL', 'list_keys'


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.
# List an account's keys.
my $SSL_list_keys = $cpliveapi->uapi(
    'SSL', 'list_keys',


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

 Command Line
uapi --user=username SSL list_keys


  • 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:


 Output (JSON)
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
      "created": "1365633436",
      "modulus": "a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acdb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafabd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a3689f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f35342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed179973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd869ef9dddf",
      "id": "b116e_473f5_ad6b3bd9517fb157830d0e37a03bc596",
      "friendly_name": "TestKey",
      "modulus_length": "2048"
  "metadata": {
    "transformed": 1


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


This function does not accept parameters.


ReturnTypeDescriptionPossible valuesExample
createdintegerThe key's creation date.A date in Unix time format.1365633415
modulusstringThe CSR's modulus.A valid string.
 Click to view...
idstringThe CSR's ID.A valid string.
 Click to view...
friendly_namestringThe CSR's friendly name.A valid string.TestCSR
modulus_lengthintegerThe length of the key's modulus, in bits.A positive integer.2048