Add document for sealwrap/rewrap endpoint (#7676)

* Add documentation for seal wrap re-wrap endpoint

* Update sample response for seal rewrap status

* Updates based on feedback from reviewers
This commit is contained in:
Michael Gaffney 2019-10-16 15:46:43 -04:00 committed by GitHub
parent 9ae3475662
commit 9f0eb3a13f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 70 additions and 0 deletions

View file

@ -0,0 +1,69 @@
---
layout: "api"
page_title: "/sys/sealwrap/rewrap - HTTP API"
sidebar_title: "<code>/sys/sealwrap/rewrap</code>"
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
```

View file

@ -141,6 +141,7 @@
'rotate',
'seal',
'seal-status',
'sealwrap-rewrap',
'step-down',
{
category: 'storage',