Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
GPG
Signing and Encryption (GnuPG Keys)

Delete GnuPG key pair

This function deletes a GnuPG (GPG) key pair.

get/GPG/delete_keypair

Query parameters

key_idstring required
Example:ACFFDB37176B680D

The ID of the GPG key that you wish to delete.

Note:

  • The function will delete all keys that match this ID.
    • If you set this parameter to a public key, the function will delete the public key.
    • If you set this parameter to a public and private key pair, the function will delete the public and private keys.
  • To obtain the desired key, call the UAPI GPG::list_secret_keys function.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "delete_keypair",
  "module": "GPG",
  "result": {
    "status": 1
  }
}