2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
2017-03-17 18:06:03 +00:00
|
|
|
|
layout: "api"
|
2017-06-07 14:02:58 +00:00
|
|
|
|
page_title: "/sys/unseal - HTTP API"
|
2018-10-29 19:58:37 +00:00
|
|
|
|
sidebar_title: "<code>/sys/unseal</code>"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
|
sidebar_current: "api-http-system-unseal"
|
2017-03-15 06:40:33 +00:00
|
|
|
|
description: |-
|
2017-06-07 14:02:58 +00:00
|
|
|
|
The `/sys/unseal` endpoint is used to unseal the Vault.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
# `/sys/unseal`
|
|
|
|
|
|
|
|
|
|
|
|
The `/sys/seal-unseal` endpoint is used to unseal the Vault.
|
|
|
|
|
|
|
|
|
|
|
|
## Submit Unseal Key
|
|
|
|
|
|
|
|
|
|
|
|
This endpoint is used to enter a single master key share to progress the
|
|
|
|
|
|
unsealing of the Vault. If the threshold number of master key shares is reached,
|
|
|
|
|
|
Vault will attempt to unseal the Vault. Otherwise, this API must be called
|
|
|
|
|
|
multiple times until that threshold is met.
|
|
|
|
|
|
|
|
|
|
|
|
Either the `key` or `reset` parameter must be provided; if both are provided,
|
|
|
|
|
|
`reset` takes precedence.
|
|
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `PUT` | `/sys/unseal` | `200 application/json` |
|
|
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
|
|
- `key` `(string: "")` – Specifies a single master key share. This is required
|
|
|
|
|
|
unless `reset` is true.
|
|
|
|
|
|
|
|
|
|
|
|
- `reset` `(bool: false)` – Specifies if previously-provided unseal keys are
|
|
|
|
|
|
discarded and the unseal process is reset.
|
|
|
|
|
|
|
2018-10-26 17:04:51 +00:00
|
|
|
|
- `migrate` `(bool: false)` - Available in 1.0 Beta - Used to migrate the seal
|
2018-10-25 23:44:53 +00:00
|
|
|
|
from shamir to autoseal or autoseal to shamir. Must be provided on all unseal
|
2018-10-26 17:04:51 +00:00
|
|
|
|
key calls.
|
2018-10-25 23:44:53 +00:00
|
|
|
|
|
2017-03-15 06:40:33 +00:00
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"key": "abcd1234..."
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--request PUT \
|
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/unseal
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
|
|
The "t" parameter is the threshold, and "n" is the number of shares.
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"sealed": true,
|
|
|
|
|
|
"t": 3,
|
|
|
|
|
|
"n": 5,
|
|
|
|
|
|
"progress": 2,
|
|
|
|
|
|
"version": "0.6.2"
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
Sample response when Vault is unsealed.
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"sealed": false,
|
|
|
|
|
|
"t": 3,
|
|
|
|
|
|
"n": 5,
|
|
|
|
|
|
"progress": 0,
|
|
|
|
|
|
"version": "0.6.2",
|
|
|
|
|
|
"cluster_name": "vault-cluster-d6ec3c7f",
|
|
|
|
|
|
"cluster_id": "3e8b3fec-3749-e056-ba41-b62a63b997e8"
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|