luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity
open-vault/website/content/api-docs/system/unseal.mdx

81 lines
1.7 KiB
Plaintext
Raw Normal View History

Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
---
New Website! (#8154) * new documentation website * ci job adjustment * update to latest version on downloads page * remove transition-period scripts * add netlify toml file * fix docs patch * fix ci config? * revert go.mod changes * a couple last markdown formatting fixes
2020-01-18 00:18:09 +00:00
layout: api
page_title: /sys/unseal - HTTP API
description: The `/sys/unseal` endpoint is used to unseal the Vault.
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
---
# `/sys/unseal`
Docs - /system/unseal Typo - Resolves: #9659 (#9660)
2020-08-05 12:33:47 +00:00
The `/sys/unseal` endpoint is used to unseal the Vault.
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
## Submit Unseal Key
Rename master key -> root key in docs (#14542)
2022-03-17 05:01:38 +00:00
This endpoint is used to enter a single root key share to progress the
unsealing of the Vault. If the threshold number of root key shares is reached,
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
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.
New Website! (#8154) * new documentation website * ci job adjustment * update to latest version on downloads page * remove transition-period scripts * add netlify toml file * fix docs patch * fix ci config? * revert go.mod changes * a couple last markdown formatting fixes
2020-01-18 00:18:09 +00:00
| Method | Path |
| :----- | :------------ |
Replace docs references to PUT with POST (#14270) The operations are handled identically, but ~85% of the references were POST, and having a mix of PUT and POST was a source of questions. A subsequent commit will update the internal use of "PUT" such as by the API client and -output-curl-string.
2022-02-25 14:52:24 +00:00
| `POST` | `/sys/unseal` |
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
### Parameters
Rename master key -> root key in docs (#14542)
2022-03-17 05:01:38 +00:00
- `key` `(string: "")` – Specifies a single root key share. This is required
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
unless `reset` is true.
- `reset` `(bool: false)` – Specifies if previously-provided unseal keys are
discarded and the unseal process is reset.
Remove beta docs (#6431)
2019-03-18 23:38:54 +00:00
- `migrate` `(bool: false)` - Available in 1.0 - Used to migrate the seal
New Website! (#8154) * new documentation website * ci job adjustment * update to latest version on downloads page * remove transition-period scripts * add netlify toml file * fix docs patch * fix ci config? * revert go.mod changes * a couple last markdown formatting fixes
2020-01-18 00:18:09 +00:00
from shamir to autoseal or autoseal to shamir. Must be provided on all unseal
Fix seal migration docs (#5623) * fixing seal migration docs * do not use deprecated command * adding redirect for old docs
2018-10-26 17:04:51 +00:00
key calls.
Updating seal docs (#5616) * updating seal docs * fixing api docs
2018-10-25 23:44:53 +00:00
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
### Sample Payload
```json
{
"key": "abcd1234..."
}
```
### Sample Request
🌷 Docs Website Maintenance (#8985) * website maintenance round * improve docs, revert bug workaround as it was fixed * boost memory * remove unnecessary code
2020-05-21 17:18:17 +00:00
```shell-session
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
$ curl \
Replace docs references to PUT with POST (#14270) The operations are handled identically, but ~85% of the references were POST, and having a mix of PUT and POST was a source of questions. A subsequent commit will update the internal use of "PUT" such as by the API client and -output-curl-string.
2022-02-25 14:52:24 +00:00
--request POST \
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
--data @payload.json \
Drop vault.rocks (#4186)
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/unseal
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
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"
}
```
Reference in a new issue Copy permalink