753e925f22
* Use new -mount syntax for all KV subcommands in 1.11 docs * Use more appropriate heading size for mount flag syntax * Add the explanatory syntax blurb from the -help text * Adjust some wording
51 lines
1.6 KiB
Plaintext
51 lines
1.6 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: kv delete - Command
|
|
description: |-
|
|
The "kv delete" command disables a secrets engine at a given PATH. The
|
|
argument corresponds to the enabled PATH of the engine, not the TYPE! All
|
|
secrets created by this engine are revoked and its Vault data is removed.
|
|
---
|
|
|
|
# kv delete
|
|
|
|
The `kv delete` command deletes the data for the provided path in
|
|
the key/value secrets engine. If using K/V Version 2, its versioned data will
|
|
not be fully removed, but marked as deleted and will no longer be returned in
|
|
normal get requests.
|
|
|
|
## Examples
|
|
|
|
Delete the latest version of the key "creds":
|
|
|
|
```shell-session
|
|
$ vault kv delete -mount=secret creds
|
|
Success! Data deleted (if it existed) at: secret/creds
|
|
```
|
|
|
|
**[K/V Version 2]** Delete version 11 of key "creds":
|
|
|
|
```shell-session
|
|
$ vault kv delete -mount=secret -versions=11 creds
|
|
Success! Data deleted (if it existed) at: secret/data/creds
|
|
```
|
|
|
|
## Usage
|
|
|
|
There are no flags beyond the [standard set of flags](/docs/commands)
|
|
included on all commands.
|
|
|
|
### Command Options
|
|
|
|
- `-mount` `(string: "")` - Specifies the path where the KV backend is mounted.
|
|
If specified, the next argument will be interpreted as the secret path. If
|
|
this flag is not specified, the next argument will be interpreted as the
|
|
combined mount path and secret path, with /data/ automatically inserted for
|
|
KV v2 secrets.
|
|
|
|
- `-versions` `([]int: <required>)` - The versions to be deleted. The versioned
|
|
data will not be deleted, but it will no longer be returned in normal get
|
|
requests.
|
|
|
|
~> **NOTE:** The `-versions` command option is only for K/V v2.
|