vault/website/content/api-docs/system/seal-status.mdx
miagilepner 4b98fd9b1a
VAULT-31751, VAULT-31752: removed_from_cluster in vault status (#28938)
* add removed from cluster to status output

* test for command

* update docs

* changelog
2024-11-19 11:13:10 +01:00

70 lines
1.4 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
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"
}
```