Child pages
  • cPanel API 2 Functions - Gpg::listsecretgpgkeys
Skip to end of metadata
Go to start of metadata

Description

This function retrieves a user's private GPG keys.


Warning:

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

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Gpg&cpanel_jsonapi_func=listsecretgpgkeys


Note:

 For more information, read our Calls from the WHM API documentation.

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


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.
 
# Retrieve private GPG keys for the user.
my $get_private_keys = $cpliveapi->api2(
	'Gpg', 'listsecretgpgkeys',

  );


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username Gpg listsecretgpgkeys


Notes:

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

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "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": "sec"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Gpg"
  }
}


Note:

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

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.

Note:

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

John Doe (user)

 

keystringThe key's characteristics.

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

Note:

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

A reason for failure.

Note:

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