---
title: "Create GnuPG key"
method: GET
path: "/GPG/generate_key"
tags: ["GPG", "Signing and Encryption (GnuPG Keys)"]
---

# Create GnuPG key

`GET /GPG/generate_key`

This function generates a GnuPG (GPG) key. The system saves the key in the user's `.gnupg` directory.

**Note:**

This function uses [the system's entropy](https://en.wikipedia.org/wiki/Entropy_(computing)) to generate the key. Systems with low entropy levels may cause long generation times or timeouts.

## Query parameters

- `email` string, email, required
- `name` string, username, required
- `passphrase` string, required
- `comment` string
- `expire` string
- `keysize` 1024 | 2048 | 3072 | 4096
- `no_expire` 0 | 1

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object, nullable
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — - `1` - Success. - `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)