Skip to content

Commit

Permalink
Update/clarify docs on generic backend ttl.
Browse files Browse the repository at this point in the history
Ping #2697
  • Loading branch information
jefferai committed May 9, 2017
1 parent 9682895 commit f163852
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
11 changes: 9 additions & 2 deletions website/source/api/secret/generic/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ $ curl \
}
```

_Note_: the `lease_duration` field (which on the CLI shows as
`refresh_interval`) is advisory. No lease is created. This is a way for writers
to indicate how often a given value shold be re-read by the client. See the
[Vault Generic backend documentation](/docs/secrets/generic/index.html) for
more details.

## List Secrets

This endpoint returns a list of key names at the specified location. Folders are
Expand Down Expand Up @@ -114,8 +120,9 @@ policy granting the `update` capability.

- `: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 above for details.
all will be returned on a read operation. A key called `ttl` will trigger
some special behavior; see the [Vault Generic backend
documentation](/docs/secrets/generic/index.html) for details.

### Sample Payload

Expand Down
2 changes: 2 additions & 0 deletions website/source/docs/secrets/generic/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ normal `lease_duration`. However, the given value will also still be returned
exactly as specified, so you are free to use that key in any way that you like
if it fits your input data.

The backend _never_ removes data on its own; the `ttl` key is merely advisory.

As an example, we can write a new key "foo" to the generic backend mounted at
"secret/" by default:

Expand Down

0 comments on commit f163852

Please sign in to comment.