You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys. See Permission reference for every permission.
--permanent erases the key completely, including its metadata. The key can keep verifying for up to about 10 seconds. Calls POST /v2/keys.deleteKey. See Enabling, disabling, and deleting keys.
Usage
Flags
string
required
Id of the key to delete.
boolean
default:"false"
Erase the key completely instead of keeping a record. Use it for compliance deletions or to reuse a key string. Analytics rows for the key lose their link to it.
Shared flags
Everyunkey api command takes these. See CLI output and shared flags.
string
Root key used for the request. Falls back to
UNKEY_ROOT_KEY, then to the key stored by unkey auth login.string
default:"https://api.unkey.com"
Base URL of the API. Falls back to
UNKEY_API_BASE_URL. You don’t normally need to set it.string
default:"~/.unkey/config.toml"
Path of the config file written by
unkey auth login. Falls back to UNKEY_CONFIG.string
Output format. Falls back to
UNKEY_OUTPUT. json prints the full response. Any other value prints the request ID and data.string
Send this JSON as the whole request body instead of using the command’s flags. You can’t combine it with them.
Required permissions
api.*.delete_key or api.<apiId>.delete_key. See Root key permissions.
Examples
Soft delete
Permanent delete
Raw body