vault.secret.kv.v1
The kv secrets engine is used to store arbitrary secrets within the configured physical storage for Vault. Writing to a key in the kv-v1 backend will replace the old value; sub-fields are not merged together.
Reference: https://www.vaultproject.io/api-docs/secret/kv/kv-v1
The kv secrets engine is used to store arbitrary secrets within the configured physical storage for Vault. Writing to a key in the kv-v1 backend will replace the old value; sub-fields are not merged together. Reference: https://www.vaultproject.io/api-docs/secret/kv/kv-v1
APIcljprotocol
The kv secrets engine is used to store arbitrary static secrets within Vault.
All of the methods in this protocol expect path to be relative to the
secret engine mount point. To specify a custom mount, use with-mount.
The kv secrets engine is used to store arbitrary static secrets within Vault. All of the methods in this protocol expect `path` to be relative to the secret engine mount point. To specify a custom mount, use `with-mount`.
delete-secret!clj
(delete-secret! client path)Delete the secret at the provided path, if any. Returns nil.
Delete the secret at the provided path, if any. Returns nil.
list-secretsclj
(list-secrets client path)List the secret names located under a path prefix location. Returns a map
with a :keys vector of name strings, where further folders are suffixed
with /. The path must be a folder; calling this method on a file or a
prefix which does not exist will return nil.
List the secret names located under a path prefix location. Returns a map with a `:keys` vector of name strings, where further folders are suffixed with `/`. The path must be a folder; calling this method on a file or a prefix which does not exist will return nil.
read-secretclj
(read-secret client path)(read-secret client path opts)Read the secret at the provided path. Returns the secret data, if present. Throws an exception or returns the provided not-found value if not.
Options:
-
:not-found(any)If no secret exists at the given path, return this value instead of throwing an exception.
-
:refresh?(boolean)Always make a read for fresh data, even if a cached secret is available.
-
:ttl(integer)Cache the data read for the given number of seconds. Overrides the TTL returned by Vault. A value of zero or less will disable caching.
Note that Vault internally stores data as JSON, so not all Clojure types will round-trip successfully!
Read the secret at the provided path. Returns the secret data, if present. Throws an exception or returns the provided not-found value if not. Options: - `:not-found` (any) If no secret exists at the given path, return this value instead of throwing an exception. - `:refresh?` (boolean) Always make a read for fresh data, even if a cached secret is available. - `:ttl` (integer) Cache the data read for the given number of seconds. Overrides the TTL returned by Vault. A value of zero or less will disable caching. Note that Vault internally stores data as JSON, so not all Clojure types will round-trip successfully!
with-mountclj
(with-mount client mount)Return an updated client which will resolve secrets against the provided
mount instead of the default. Passing nil will reset the client to the
default.
Return an updated client which will resolve secrets against the provided mount instead of the default. Passing `nil` will reset the client to the default.
write-secret!clj
(write-secret! client path data)Store secret data at the provided path, overwriting any secret that was
previously stored there. Returns nil. Writing a :ttl key as part of the
secret will control the pseudo lease duration returned when the secret is
read.
Note that Vault internally stores data as JSON, so not all Clojure types will round-trip successfully!
Store secret data at the provided path, overwriting any secret that was previously stored there. Returns nil. Writing a `:ttl` key as part of the secret will control the pseudo lease duration returned when the secret is read. Note that Vault internally stores data as JSON, so not all Clojure types will round-trip successfully!
default-mountclj
Default mount point to use if one is not provided.
Default mount point to use if one is not provided.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close