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

58 lines
1 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/seal-status - HTTP API
description: The `/sys/seal-status` endpoint is used to check the seal status of a 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/seal-status`
The `/sys/seal-status` endpoint is used to check the seal status of a Vault.
## Seal Status
This endpoint returns the seal status of the Vault. This is an unauthenticated
endpoint.
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 |
| :----- | :----------------- |
| `GET` | `/sys/seal-status` |
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 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 \
Drop vault.rocks (#4186)
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/seal-status
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
{
added the missing nonce and type fields (#3694)
2017-12-17 21:26:07 +00:00
"type": "shamir",
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
"sealed": true,
"t": 3,
"n": 5,
"progress": 2,
added the missing nonce and type fields (#3694)
2017-12-17 21:26:07 +00:00
"nonce": "",
"version": "0.9.0"
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 when Vault is unsealed.
```json
{
added the missing nonce and type fields (#3694)
2017-12-17 21:26:07 +00:00
"type": "shamir",
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
"sealed": false,
"t": 3,
"n": 5,
"progress": 0,
added the missing nonce and type fields (#3694)
2017-12-17 21:26:07 +00:00
"version": "0.9.0",
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
"cluster_name": "vault-cluster-d6ec3c7f",
added the missing nonce and type fields (#3694)
2017-12-17 21:26:07 +00:00
"cluster_id": "3e8b3fec-3749-e056-ba41-b62a63b997e8",
"nonce": "ef05d55d-4d2c-c594-a5e8-55bc88604c24"
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
}
```
Reference in a new issue Copy permalink