mirror of
https://github.com/hashicorp/vault.git
synced 2025-09-06 22:41:08 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
80 lines
2.5 KiB
Plaintext
80 lines
2.5 KiB
Plaintext
---
|
||
layout: api
|
||
page_title: /sys/wrapping/unwrap - HTTP API
|
||
description: The `/sys/wrapping/unwrap` endpoint unwraps a wrapped response.
|
||
---
|
||
|
||
> [!IMPORTANT]
|
||
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
||
|
||
# `/sys/wrapping/unwrap`
|
||
|
||
The `/sys/wrapping/unwrap` endpoint unwraps a wrapped response.
|
||
|
||
## Wrapping unwrap
|
||
|
||
This endpoint returns the original response inside the given wrapping token.
|
||
Unlike simply reading `cubbyhole/response` (which is deprecated), this endpoint
|
||
provides additional validation checks on the token, returns the original value
|
||
on the wire rather than a JSON string representation of it, and ensures that the
|
||
response is properly audit-logged.
|
||
|
||
This endpoint can be used by using a wrapping token as the client token in the
|
||
API call, in which case the `token` parameter is not required; or, a different
|
||
token with permissions to access this endpoint can make the call and pass in the
|
||
wrapping token in the `token` parameter. Do _not_ use the wrapping token in both
|
||
locations; this will cause the wrapping token to be revoked but the value to be
|
||
unable to be looked up, as it will basically be a double-use of the token!
|
||
|
||
| Method | Path |
|
||
| :----- | :--------------------- |
|
||
| `POST` | `/sys/wrapping/unwrap` |
|
||
|
||
### Parameters
|
||
|
||
- `token` `(string: "")` – Specifies the wrapping token ID. This is required if
|
||
the client token is not the wrapping token. Do not use the wrapping token in
|
||
both locations.
|
||
|
||
### Sample payload
|
||
|
||
```json
|
||
{
|
||
"token": "abcd1234..."
|
||
}
|
||
```
|
||
|
||
### Sample request
|
||
|
||
```shell-session
|
||
$ curl \
|
||
--header "X-Vault-Token: ..." \
|
||
--request POST \
|
||
--data @payload.json \
|
||
http://127.0.0.1:8200/v1/sys/wrapping/unwrap
|
||
```
|
||
|
||
Or you can use token to unwrap without authentication in vault
|
||
|
||
```shell-session
|
||
$ curl \
|
||
--header "X-Vault-Token: abcd1234..." \
|
||
--request POST \
|
||
http://127.0.0.1:8200/v1/sys/wrapping/unwrap
|
||
```
|
||
|
||
### Sample response
|
||
|
||
```json
|
||
{
|
||
"request_id": "8e33c808-f86c-cff8-f30a-fbb3ac22c4a8",
|
||
"lease_id": "",
|
||
"lease_duration": 2592000,
|
||
"renewable": false,
|
||
"data": {
|
||
"zip": "zap"
|
||
},
|
||
"warnings": null
|
||
}
|
||
```
|