open-vault/website/content/api-docs/system/sealwrap-rewrap.mdx

71 lines
1.6 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
layout: api
page_title: /sys/sealwrap/rewrap - HTTP API
description: >-
The `/sys/sealwrap/rewrap` endpoint is used to rewrap all seal wrapped
entries.
---
# `/sys/sealwrap/rewrap`
~> **Enterprise Only**  These endpoints require Vault Enterprise.
The `/sys/sealwrap/rewrap` endpoint is used to rewrap all seal wrapped entries.
This is useful when you want to upgrade seal wrapped entries to use the latest
key, for example, after a seal migration or after rotating the remote keyring.
## Read Rewrap Status
This endpoint reports whether a seal rewrap process is currently running.
| Method | Path |
| :----- | :--------------------- |
| `GET` | `/sys/sealwrap/rewrap` |
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/sealwrap/rewrap
```
### Sample Response
```json
{
"data": {
"entries": {
"failed": 0,
"processed": 30,
"succeeded": 30
},
"is_running": false
}
}
```
## Start a Seal Rewrap Process
This endpoint starts a seal rewrap process if one is not currently running.
The process will run in the background. Check the vault server logs for status
and progress updates.
| Method | Path |
| :----- | :--------------------- |
| `POST` | `/sys/sealwrap/rewrap` |
The default status codes are:
- `200` if a seal rewrap process is already running
- `204` if a seal rewrap process was started
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
http://127.0.0.1:8200/v1/sys/sealwrap/rewrap
```