Delete GnuPG key pair

This function deletes a GnuPG (GPG) key pair.

SecurityBasicAuth

Request

query Parameters

key_id

required

string

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.

Example: key_id=ACFFDB37176B680D

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/GPG/delete_keypair

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  GPG \
  delete_keypair \
  key_id='ACFFDB37176B680D'

Response samples

application/json

{"apiversion": 3,
"func": "delete_keypair",
"module": "GPG",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}