cPanel API 2 Functions - Gpg::listsecretgpgkeys


This function retrieves a user's private GPG keys.


We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.




 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
// Retrieve private GPG keys for the user.
$get_private_keys $cpanel->api2(

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
# Retrieve private GPG keys for the user.
my $get_private_keys $cpliveapi->api2(

 cPanel Tag System (deprecated)


In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.


 Command Line

cpapi2 --user=username Gpg listsecretgpgkeys



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

 Output (JSON)

  "cpanelresult": {
    "apiversion": 2,
    "func": "listgpgkeys",
    "data": [
        "date": "2014-10-14",
        "name": "John Doe (user)",
        "key": "738538C1 [1024D] John Doe (user) (",
        "email": "",
        "keyid": "738538C1",
        "bits": "1024D",
        "id": "738538C1",
        "type": "sec"
    "event": {
      "result": 1
    "module": "Gpg"



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



This function does not accept parameters.





Possible values




 The key's creation date.

 A comma-separated list of dates in YYYY-MM-DD format, where:

  • YYYY represents the year.
  • MM represents the month.
  • DD represents the date.




 The key's long and short names.

 A string value.


 The key's short name and encoded email address are in parenthesis.

 John Doe (user)




 The key's characteristics.

 The key's ID, length long name, short name, and encoded email address.


  • The key's length is in brackets.
  • The key's short name and encoded email address are in parenthesis. 

 738538C1 [1024D] John Doe (user)(




 The email address encoded in the key.

 A valid email address.



 The key's ID.

 A string value.




 The key's length.

 The key's length, in bits.




 The key's ID.

 A string value.




 Whether the key is public.

  • pub — Public.
  • sec — Private.




 A reason for failure.



 This function only returns areasonvalue if there was an error. 



 A string that describes the error.

 This is an error message.



 Whether the function succeeded


  • 1 — The function succeeded.
  • 0 — The function failed.



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