Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add document for sealwrap/rewrap endpoint #7676

Merged
merged 5 commits into from
Oct 16, 2019
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions website/source/api/system/sealwrap-rewrap.html.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice to include why someone might want to use a rewrap. e.g. after a seal migration, if you rotate the remote keyring and want to upgrade entries

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in #7689


## Read Rewrap Status

This endpoint retrieves if a seal rewrap process is currently running.
mgaffney marked this conversation as resolved.
Show resolved Hide resolved

| 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
{
"request_id": "a6a51003-2576-be0b-9a43-d3bdfeafc2f7",
"lease_id": "",
"lease_duration": 0,
"renewable": false,
"data": {
mgaffney marked this conversation as resolved.
Show resolved Hide resolved
"entries": {
"failed": 0,
"processed": 30,
"succeeded": 30
},
"is_running": false
},
"warnings": null
}
```

## 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
mgaffney marked this conversation as resolved.
Show resolved Hide resolved
- `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
```
1 change: 1 addition & 0 deletions website/source/layouts/api.erb
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@
'rotate',
'seal',
'seal-status',
'sealwrap-rewrap',
'step-down',
{
category: 'storage',
Expand Down