upstream/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-04-01 23:25:03 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
vault/website/source/docs/commands/read.html.md
Seth Vargo 8e0eeade04
Add "read" command documentation
2017-10-24 09:30:52 -04:00

1.3 KiB
Raw Blame History

layout page_title sidebar_current description
docs read - Command docs-commands-read The "read" command reads data from Vault at the given path. This can be used to read secrets, generate dynamic credentials, get configuration details, and more.

read

The read command reads data from Vault at the given path. This can be used to read secrets, generate dynamic credentials, get configuration details, and more.

For a full list of examples and paths, please see the documentation that corresponds to the secrets engine in use.

Examples

Read a secret from the static secrets engine:

$ vault read secret/my-secret
Key                 Value
---                 -----
refresh_interval    768h
foo                 bar

Usage

The following flags are available in addition to 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 idea 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.