Add docs for new datakeys endpoint #843
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Vercel Previews Deployed
|
Broken Link Checker |
schavis
requested changes
Aug 26, 2025
Comment on lines
+1206
to
+1211
| This endpoint generates a specified number of new high-entropy keys and encrypts them with the | ||
| named key. Optionally return the plaintext of the keys as well. Whether plaintext | ||
| is returned depends on the path; as a result, you can use Vault ACL policies to | ||
| control whether a user is allowed to retrieve the plaintext value of the keys. This | ||
| is useful if you want an untrusted user or operation to generate keys that are | ||
| then made available to trusted users. |
There was a problem hiding this comment.
Suggested change
| This endpoint generates a specified number of new high-entropy keys and encrypts them with the | |
| named key. Optionally return the plaintext of the keys as well. Whether plaintext | |
| is returned depends on the path; as a result, you can use Vault ACL policies to | |
| control whether a user is allowed to retrieve the plaintext value of the keys. This | |
| is useful if you want an untrusted user or operation to generate keys that are | |
| then made available to trusted users. | |
| The data keys endpoint generates the specified number of new, high-entropy keys. | |
| Vault always returns keys encrypted with the provided named and optionally | |
| returns the associated plaintext. | |
| You can use Vault ACL policies to control which users can retrieve the plaintext | |
| value of the keys. For example, to allow untrusted users or operations to | |
| generate keys that are then available to trusted users. |
Style correction: write in active voice, use complete sentences in paragraphs
| | :----- | :----------------------------- | | ||
| | `POST` | `/transit/datakeys/:type/:name` | | ||
|
|
||
| ### Parameters |
There was a problem hiding this comment.
Suggested change
| ### Parameters | |
| ### Path parameters |
Comment on lines
+1219
to
+1222
| - `type` `(string: <required>)` – Specifies the type of keys to generate. If | ||
| `plaintext`, the plaintext keys will be returned along with the ciphertexts. If | ||
| `wrapped`, only the ciphertext values will be returned. This is specified as | ||
| part of the URL. |
There was a problem hiding this comment.
Suggested change
| - `type` `(string: <required>)` – Specifies the type of keys to generate. If | |
| `plaintext`, the plaintext keys will be returned along with the ciphertexts. If | |
| `wrapped`, only the ciphertext values will be returned. This is specified as | |
| part of the URL. | |
| - `type` `(enum: <required>)` – Specifies the type of keys to generate. | |
| - `plaintext` - return the plaintext keys along with the ciphertexts | |
| - `wrapped` - only return the ciphertext values. |
|
|
||
| - `name` `(string: <required>)` – Specifies the name of the encryption key to | ||
| use to encrypt the datakeys. This is specified as part of the URL. | ||
|
|
There was a problem hiding this comment.
Suggested change
| ### Request parameters | |
Comment on lines
+1224
to
+1225
| - `name` `(string: <required>)` – Specifies the name of the encryption key to | ||
| use to encrypt the datakeys. This is specified as part of the URL. |
There was a problem hiding this comment.
Suggested change
| - `name` `(string: <required>)` – Specifies the name of the encryption key to | |
| use to encrypt the datakeys. This is specified as part of the URL. | |
| - `name` `(string: <required>)` – Specifies the name of the encryption key to | |
| use to encrypt the datakeys. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.