Mike Green 12fba35a7c Update docs to add example of field output for KV get (#8109 )

* Add example of field output

Ordering matters here and its a constant question both from customers and new folks. This will help to show the right syntax.

* minor update to spelling and force unit test rerun

* Update example actually in example area

* Clarify last example is only unix example

* removing Unix specific example

2020-01-08 15:58:10 -08:00

2 KiB

Raw Blame History

layout	page_title	sidebar_title	sidebar_current	description
docs	kv get - Command	<code>get</code>	docs-commands-kv-get	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.

kv get

The kv get command retrieves the value from K/V 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":

$ vault kv get secret/creds
====== Metadata ======
Key              Value
---              -----
created_time     2019-06-06T06:03:26.595978Z
deletion_time    n/a
destroyed        false
version          5

====== Data ======
Key         Value
---         -----
passcode    my-long-passcode

If K/V Version 1 secrets engine is enabled at "secret", the output has no metadata since there is no versioning information associated with the data:

$ vault kv get secret/creds
====== Data ======
Key         Value
---         -----
passcode    my-long-passcode

Return only the "creds" "passcode" key:

$ vault kv get -field=passcode secret/creds
my-long-passcode

Usage

There are no flags beyond the standard set of flags included on all commands.

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

-version (int: 0) - Specifies the version to return. If not set the latest version is returned.

2 KiB Raw Blame History