cPanel API 2 Functions - Gpg::listsecretgpgkeys - Knowledgebase

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.

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

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'

);

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

);

cPanel Tag System (deprecated)

Warning:

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

Notes:

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) (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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
date	string	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
name	string	The 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)
key	string	The 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)
email	string	The email address encoded in the key.	A valid email address.	user@example.com
keyid	string	The key's ID.	A string value.	738538C1
bits	string	The key's length.	The key's length, in bits.	1024D
id	string	The key's ID.	A string value.	738538C1
type	string	Whether the key is public.	pub — Public. sec — Private.	sec
reason	string	A reason for failure. Note: This function only returns areasonvalue if there was an error.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories