Description

This function retrieves public GPG keys.

Examples 




https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Gpg&cpanel_jsonapi_func=listgpgkeys



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Retrieve GPG keys for the user.
$get_public_keys = $cpanel->api2(
    'Gpg', 'listgpgkeys'
	
);

 



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

  );

 




cpapi2 --user=username Gpg listgpgkeys



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



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
datestring

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.
2014-10-14
namestringThe key's long and short names.

A string value.

The key's short name is in parenthesis.


John Doe (user)
keystringThe 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) (user@example.com)
emailstringThe user's email address.A valid email address.
user@example.com
keyidstringThe key's ID.A string value.
738538C1
bitsstringThe key's length.The length of the key, in bits.1024D
idstringThe key's ID.A string value.738538C1
typestringWhether the key is public.
  • pub — Public.
  • sec — Private.
pub
reasonstring

A reason for failure.

This function only returns a reason value if there was an error. 


A string that describes the error. This is an error message.
resultBoolean

Whether the function succeeded

 

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