mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-11-02 11:38:02 +00:00
cf43d3eeed
* Add administrative namespace section to namespaces docs * Tag sys endpoints with restricted admin alert --------- Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
70 lines
1.3 KiB
Plaintext
70 lines
1.3 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.
|
|
---
|
|
|
|
# `/sys/seal-status`
|
|
|
|
The `/sys/seal-status` endpoint is used to check the seal status of a Vault.
|
|
|
|
## Seal status
|
|
|
|
@include 'alerts/restricted-admin.mdx'
|
|
|
|
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
|
|
{
|
|
"type": "shamir",
|
|
"initialized": true,
|
|
"sealed": true,
|
|
"t": 3,
|
|
"n": 5,
|
|
"progress": 2,
|
|
"nonce": "",
|
|
"version": "1.11.0",
|
|
"build_date": "2022-05-03T08:34:11Z",
|
|
"migration": false,
|
|
"recovery_seal": false,
|
|
"storage_type": "file"
|
|
}
|
|
```
|
|
|
|
Sample response when Vault is unsealed.
|
|
|
|
```json
|
|
{
|
|
"type": "shamir",
|
|
"initialized": true,
|
|
"sealed": false,
|
|
"t": 3,
|
|
"n": 5,
|
|
"progress": 0,
|
|
"nonce": "",
|
|
"version": "1.11.0",
|
|
"build_date": "2022-05-03T08:34:11Z",
|
|
"migration": false,
|
|
"cluster_name": "vault-cluster-336172e1",
|
|
"cluster_id": "f94053ad-d80e-4270-2006-2efd67d0910a",
|
|
"recovery_seal": false,
|
|
"storage_type": "file"
|
|
}
|
|
```
|