mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 15:11:07 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
73 lines
1.8 KiB
Plaintext
73 lines
1.8 KiB
Plaintext
---
|
|
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.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# `/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.
|
|
|
|
| Method | Path |
|
|
| :----- | :----------------- |
|
|
| `GET` | `/sys/seal-status` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ curl \
|
|
http://127.0.0.1:8200/v1/sys/seal-status
|
|
```
|
|
|
|
### Sample response
|
|
|
|
The "t" parameter is the threshold, and "n" is the number of shares.
|
|
|
|
```json
|
|
{
|
|
"build_date": "2024-11-15T14:17:42Z",
|
|
"initialized": true,
|
|
"migration": false,
|
|
"n": 3,
|
|
"nonce": "",
|
|
"progress": 1,
|
|
"recovery_seal": false,
|
|
"removed_from_cluster": false,
|
|
"sealed": true,
|
|
"storage_type": "raft",
|
|
"t": 2,
|
|
"type": "shamir",
|
|
"version": "1.19.0-beta1"
|
|
}
|
|
```
|
|
|
|
Sample response when Vault is unsealed.
|
|
|
|
```json
|
|
{
|
|
"build_date": "2024-11-14T18:11:15Z",
|
|
"cluster_id": "ebdd80fb-0c7f-bce9-f9b9-a0fa86aa3249",
|
|
"cluster_name": "vault-cluster-f090409a",
|
|
"initialized": true,
|
|
"migration": false,
|
|
"n": 3,
|
|
"nonce": "",
|
|
"progress": 0,
|
|
"recovery_seal": false,
|
|
"removed_from_cluster": false,
|
|
"sealed": false,
|
|
"storage_type": "raft",
|
|
"t": 2,
|
|
"type": "shamir",
|
|
"version": "1.19.0-beta1"
|
|
}
|
|
```
|