2017-09-08 02:14:04 +00:00
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
layout: docs
|
|
|
|
|
page_title: read - Command
|
2017-09-08 02:14:04 +00:00
|
|
|
description: |-
|
|
|
|
|
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:
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
```shell-session
|
2017-09-08 02:14:04 +00:00
|
|
|
$ 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
|
2020-01-22 20:05:41 +00:00
|
|
|
flags](/docs/commands) included on all commands.
|
2017-09-08 02:14:04 +00:00
|
|
|
|
|
|
|
|
### Output Options
|
|
|
|
|
|
|
|
|
|
- `-field` `(string: "")` - Print only the field with the given name. Specifying
|
|
|
|
|
this option will take precedence over other formatting directives. The result
|
2018-02-12 23:12:16 +00:00
|
|
|
will not have a trailing newline making it ideal for piping to other processes.
|
2017-09-08 02:14:04 +00:00
|
|
|
|
|
|
|
|
- `-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.
|
