# cPanel API 2 Functions - Gpg::listgpgkeys

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function retrieves public GPG keys.

Warning:
We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function:

- [`GPG::list_public_keys`](/openapi/cpanel/operation/list_public_keys)  — This function lists the GPG public keys for the currently-authenticated account.


## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Gpg listgpgkeys
```

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
date
td
em
string
td
p
The key's creation date.
td
A comma-separated list of dates in 
code
YYYY-MM-DD
 format, where:

ul
li
code
YYYY
 represents the year.
li
code
MM
 represents the month.
li
code
DD
 represents the date.
td
code
2014-10-14
tr
td
code
name
td
em
string
td
The key's long and short names.
td
p
span
A string value
.
p
The key's short name is in parenthesis.
td
code
John Doe (user)
tr
td
code
key
td
em
string
td
The key's characteristics.
td
p
The key's ID, length long name, short name, and encoded email address.
ul
li
The key's length is in brackets.
li
The key's short name and encoded email address are in parenthesis.
td
code
738538C1 [1024D] John Doe (user) (user@example.com)
tr
td
code
email
td
em
string
td
The user's email address.
td
A valid email address.
td
code
user@example.com
tr
td
code
keyid
td
em
string
td
The key's ID.
td
A string value.
td
code
738538C1
tr
td
code
bits
td
em
string
td
The key's length.
td
The length of the key, in bits.
td
code
1024D
tr
td
code
id
td
em
string
td
The key's ID.
td
A string value.
td
code
738538C1
tr
td
code
type
td
em
string
td
Whether the key is public.
td
ul
li
code
pub
 — Public.
li
code
sec
 — Private.
td
code
pub
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
 value if there was an error. 
td
span
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded
p
br
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1