scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-11-02 03:27:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

backport of commit 8e40823fe1 (#21416)

Browse Source 
Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
This commit is contained in:
hc-github-team-secure-vault-core
2023-06-22 13:56:53 -04:00
committed by GitHub
parent 4b5c5c07e2
commit b693f0f247
3 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/content/api-docs/secret/cubbyhole.mdx
View File

@@ -105,7 +105,7 @@ This endpoint stores a secret at the specified location.
- `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
- `:key` `(string: "")` – Specifies a key in the payload, 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.

16
website/content/api-docs/secret/kv/kv-v1.mdx
View File

@@ -1,14 +1,16 @@
---
layout: api
page_title: KV - Secrets Engines - HTTP API
description: This is the API documentation for the Vault KV secrets engine.
description: This is the API documentation for the Vault KV secrets engine, version 1.
---
# KV Secrets Engine - Version 1 (API)
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](/vault/docs/secrets/kv).
information about the usage and operation of the version 1 KV secrets engine, please
see the [Vault KV documentation](/vault/docs/secrets/kv/kv-v1). For information
about the differences between KV version 1 and version 2, please [see the KV overview
documentation](/vault/docs/secrets/kv).
~> Note: 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
@@ -53,7 +55,7 @@ $ curl \
_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](/vault/docs/secrets/kv)
See the [Vault KV secrets engine documentation](/vault/docs/secrets/kv/kv-v1#ttls)
for more details.
## List Secrets
@@ -62,7 +64,7 @@ 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.
this API.
| Method | Path |
| :----- | :-------------- |
@@ -116,11 +118,11 @@ policy granting the `update` capability.
- `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
- `:key` `(string: "")` – Specifies a key in the payload, 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](/vault/docs/secrets/kv) for details.
documentation](/vault/docs/secrets/kv/kv-v1#ttls) for details.
### Sample Payload

7
website/content/api-docs/secret/kv/kv-v2.mdx
View File

@@ -1,14 +1,15 @@
---
layout: api
page_title: KV - Secrets Engines - HTTP API
description: This is the API documentation for the Vault KV secrets engine.
description: This is the API documentation for the Vault KV secrets engine, version 2.
---
# KV Secrets Engine - Version 2 (API)
This is the API documentation for the Vault KV secrets engine while running in
versioned mode. For general information about the usage and operation of the kv
secrets engine, please see the [Vault kv
versioned mode. For general information about the usage and operation of the version 2
KV secrets engine, please see the [Vault KV documentation](/vault/docs/secrets/kv/kv-v2).
For information about the differences between KV version 1 and version 2, please [see the KV overview
documentation](/vault/docs/secrets/kv).
## Configure the KV Engine