mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 23:21:08 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
84 lines
2.7 KiB
Plaintext
84 lines
2.7 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: kv get - Command
|
|
description: |-
|
|
The "kv get" command retrieves the value from Vault's key-value store at the
|
|
given key name. If no key exists with that name, an error is returned. If a
|
|
key exists with that name but has no data, nothing is returned.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# kv get
|
|
|
|
The `kv get` command retrieves the value from KV secrets engine at the given
|
|
key name. If no key exists with that name, an error is returned. If a key exists
|
|
with the name but has no data, nothing is returned.
|
|
|
|
## Examples
|
|
|
|
Retrieve the data of the key "creds":
|
|
|
|
```shell-session
|
|
$ vault kv get -mount=secret creds
|
|
== Secret Path ==
|
|
secret/data/creds
|
|
|
|
======= Metadata =======
|
|
Key Value
|
|
--- -----
|
|
created_time 2022-06-15T20:23:40.067093Z
|
|
custom_metadata <nil>
|
|
deletion_time n/a
|
|
destroyed false
|
|
version 1
|
|
|
|
====== Data ======
|
|
Key Value
|
|
--- -----
|
|
passcode my-long-passcode
|
|
```
|
|
|
|
If KV version 1 secrets engine is enabled at "secret", the output has no
|
|
metadata since there is no versioning information associated with the data:
|
|
|
|
```shell-session
|
|
$ vault kv get -mount=secret creds
|
|
====== Data ======
|
|
Key Value
|
|
--- -----
|
|
passcode my-long-passcode
|
|
```
|
|
|
|
Return only the "creds" "passcode" key:
|
|
|
|
```shell-session
|
|
$ vault kv get -mount=secret -field=passcode creds
|
|
my-long-passcode
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Output options
|
|
|
|
- `-field` `(string: "")` - Print only the field with the given name. Specifying
|
|
this option will take precedence over other formatting directives. The result
|
|
will not have a trailing newline making it ideal for piping to other
|
|
processes.
|
|
|
|
- `-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.
|
|
|
|
### 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.
|
|
|
|
- `-version` `(int: 0)` - Specifies the version to return. If not set the
|
|
latest version is returned.
|