cPanel API 2 Functions - Gpg::listgpgkeys

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.


Description

This function retrieves public GPG keys.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

  • GPG::list_public_keys — This function lists the GPG public keys for the currently-authenticated account.

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=listgpgkeys
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 GPG keys for the user.
$get_public_keys = $cpanel->api2(
    'Gpg', 'listgpgkeys'

);
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 GPG keys for the user.
my $get_public_keys = $cpliveapi->api2(
    'Gpg', 'listgpgkeys',

  );
Note:

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


cPanel Tag System (deprecated)

Warnings:
  • 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 listgpgkeys
Notes:
  • You must URI-encode values.
  • username represents your account-level username.
  • You must include the --user=username option.
  • 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": "pub"
      }
    ],
    "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

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.

The key's short name is in parenthesis.

John Doe (user)
key string 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) (user@example.com)
email string The user's email address. A valid email address. user@example.com
keyid string The key's ID. A string value. 738538C1
bits string The key's length. The length of the key, in bits. 1024D
id string The key's ID. A string value. 738538C1
type string Whether the key is public.
  • pub — Public.
  • sec — Private.
pub
reason string

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.
result Boolean

Whether the function succeeded


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