2018-03-22 03:10:05 +00:00
|
|
|
|
---
|
|
|
|
|
layout: "api"
|
|
|
|
|
page_title: "KV - Secrets Engines - HTTP API"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
|
sidebar_title: "K/V Version 1"
|
|
|
|
|
sidebar_current: "api-http-secret-kv-v1"
|
2018-03-22 03:10:05 +00:00
|
|
|
|
description: |-
|
|
|
|
|
This is the API documentation for the Vault KV secrets engine.
|
|
|
|
|
---
|
|
|
|
|
|
2018-04-09 16:39:32 +00:00
|
|
|
|
# KV Secrets Engine - Version 1 (API)
|
2018-03-22 03:10:05 +00:00
|
|
|
|
|
|
|
|
|
This is the API documentation for the Vault KV secrets engine. For general
|
|
|
|
|
information about the usage and operation of the kv secrets engine, please
|
|
|
|
|
see the [Vault kv documentation](/docs/secrets/kv/index.html).
|
|
|
|
|
|
|
|
|
|
This documentation assumes the kv secrets engine is enabled at the
|
|
|
|
|
`/secret` path in Vault. Since it is possible to enable secrets engines at any
|
|
|
|
|
location, please update your API calls accordingly.
|
|
|
|
|
|
|
|
|
|
## Read Secret
|
|
|
|
|
|
|
|
|
|
This endpoint retrieves the secret at the specified location.
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :--------------------------- | :--------------------- |
|
|
|
|
|
| `GET` | `/secret/:path` |
|
2018-03-22 03:10:05 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `path` `(string: <required>)` – Specifies the path of the secret to read.
|
|
|
|
|
This is specified as part of the URL.
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
2018-04-04 06:22:41 +00:00
|
|
|
|
https://127.0.0.1:8200/v1/secret/my-secret
|
2018-03-22 03:10:05 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"auth": null,
|
|
|
|
|
"data": {
|
2019-02-07 02:51:08 +00:00
|
|
|
|
"foo": "bar",
|
|
|
|
|
"ttl": "1h"
|
2018-03-22 03:10:05 +00:00
|
|
|
|
},
|
2019-02-07 02:51:08 +00:00
|
|
|
|
"lease_duration": 3600,
|
2018-03-22 03:10:05 +00:00
|
|
|
|
"lease_id": "",
|
|
|
|
|
"renewable": false
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2019-02-07 02:51:08 +00:00
|
|
|
|
_Note_: the `lease_duration` field, which will be populated if a "ttl" field
|
|
|
|
|
was included in the data, is advisory. No lease is created. This is a way for
|
|
|
|
|
writers to indicate how often a given value should be re-read by the client.
|
|
|
|
|
See the [Vault KV secrets engine documentation](/docs/secrets/kv/index.html)
|
2018-03-22 03:10:05 +00:00
|
|
|
|
for more details.
|
|
|
|
|
|
|
|
|
|
## List Secrets
|
|
|
|
|
|
|
|
|
|
This endpoint 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.
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :--------------------------- | :--------------------- |
|
|
|
|
|
| `LIST` | `/secret/:path` |
|
2018-03-22 03:10:05 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `path` `(string: <required>)` – Specifies the path of the secrets to list.
|
|
|
|
|
This is specified as part of the URL.
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request LIST \
|
2018-04-04 06:22:41 +00:00
|
|
|
|
https://127.0.0.1:8200/v1/secret/my-secret
|
2018-03-22 03:10:05 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
The example below shows output for a query path of `secret/` when there are
|
|
|
|
|
secrets at `secret/foo` and `secret/foo/bar`; note the difference in the two
|
|
|
|
|
entries.
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"auth": null,
|
|
|
|
|
"data": {
|
|
|
|
|
"keys": ["foo", "foo/"]
|
|
|
|
|
},
|
|
|
|
|
"lease_duration": 2764800,
|
|
|
|
|
"lease_id": "",
|
|
|
|
|
"renewable": false
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Create/Update Secret
|
|
|
|
|
|
|
|
|
|
This endpoint stores a secret at the specified location. If the value does not
|
|
|
|
|
yet exist, the calling token must have an ACL policy granting the `create`
|
|
|
|
|
capability. If the value already exists, the calling token must have an ACL
|
|
|
|
|
policy granting the `update` capability.
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :--------------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/secret/:path` |
|
|
|
|
|
| `PUT` | `/secret/:path` |
|
2018-03-22 03:10:05 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `path` `(string: <required>)` – Specifies the path of the secrets to
|
|
|
|
|
create/update. This is specified as part of the URL.
|
|
|
|
|
|
|
|
|
|
- `:key` `(string: "")` – Specifies a key, paired with an associated value, to
|
|
|
|
|
be held at the given location. Multiple key/value pairs can be specified, and
|
|
|
|
|
all will be returned on a read operation. A key called `ttl` will trigger
|
|
|
|
|
some special behavior. See the [Vault KV secrets engine
|
|
|
|
|
documentation](/docs/secrets/kv/index.html) for details.
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"foo": "bar",
|
|
|
|
|
"zip": "zap"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
2018-04-04 06:22:41 +00:00
|
|
|
|
https://127.0.0.1:8200/v1/secret/my-secret
|
2018-03-22 03:10:05 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Delete Secret
|
|
|
|
|
|
|
|
|
|
This endpoint deletes the secret at the specified location.
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :--------------------------- | :--------------------- |
|
|
|
|
|
| `DELETE` | `/secret/:path` |
|
2018-03-22 03:10:05 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `path` `(string: <required>)` – Specifies the path of the secret to delete.
|
|
|
|
|
This is specified as part of the URL.
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request DELETE \
|
2018-04-04 06:22:41 +00:00
|
|
|
|
https://127.0.0.1:8200/v1/secret/my-secret
|
2018-03-22 03:10:05 +00:00
|
|
|
|
```
|