diff --git a/website/source/api/system/sealwrap-rewrap.html.md b/website/source/api/system/sealwrap-rewrap.html.md new file mode 100644 index 0000000000..780da0cdf3 --- /dev/null +++ b/website/source/api/system/sealwrap-rewrap.html.md @@ -0,0 +1,69 @@ +--- +layout: "api" +page_title: "/sys/sealwrap/rewrap - HTTP API" +sidebar_title: "/sys/sealwrap/rewrap" +sidebar_current: "api-http-system-sealwrap-rewrap" +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. + +## Read Rewrap Status + +This endpoint reports whether a seal rewrap process is currently running. + +| Method | Path | +| :------- | :--------------------- | +| `GET` | `/sys/sealwrap/rewrap` | + +### Sample Request + +``` +$ 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 + +``` +$ curl \ + --header "X-Vault-Token: ..." \ + --request POST \ + http://127.0.0.1:8200/v1/sys/sealwrap/rewrap +``` diff --git a/website/source/layouts/api.erb b/website/source/layouts/api.erb index df8625e931..0bdc22495c 100644 --- a/website/source/layouts/api.erb +++ b/website/source/layouts/api.erb @@ -141,6 +141,7 @@ 'rotate', 'seal', 'seal-status', + 'sealwrap-rewrap', 'step-down', { category: 'storage',