058710d33d
* add flag Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * handle kv paths Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * scaffold test Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * need metadata for list paths Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * add (broken) test Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * fix test Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * update docs Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * add changelog Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * format Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * add godoc Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * add test case for mount only Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * handle case of no unnamed arg Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * add non-mount behavior Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * add more detail to comment Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> * add v1 tests Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com> --------- Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>
50 lines
1.4 KiB
Plaintext
50 lines
1.4 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: kv list - Command
|
|
description: |-
|
|
The "kv list" command lists data from Vault's K/V secrets engine at the given
|
|
path.
|
|
---
|
|
|
|
# kv list
|
|
|
|
The `kv list` command returns a list of key names at the specified location.
|
|
Folders are suffixed with /. The input must be a folder; list on a file will not
|
|
return a value. Note that no policy-based filtering is performed on keys; do not
|
|
encode sensitive information in key names. The values themselves are not
|
|
accessible via this command.
|
|
|
|
Use this command to list all existing key names at a specific path.
|
|
|
|
## Examples
|
|
|
|
List values under the key "my-app":
|
|
|
|
```shell-session
|
|
$ vault kv list -mount=secret my-app/
|
|
Keys
|
|
----
|
|
admin_creds
|
|
domain
|
|
eng_creds
|
|
qa_creds
|
|
release
|
|
```
|
|
|
|
## Usage
|
|
|
|
There are no flags beyond the [standard set of flags](/vault/docs/commands)
|
|
included on all commands.
|
|
|
|
### Output 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.
|
|
|
|
- `-format` `(string: "table")` - Print the output in the given format. Valid
|
|
formats are "table", "json", or "yaml". This can also be specified via the
|
|
`VAULT_FORMAT` environment variable.
|