mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-15 19:17:02 +02:00
036cbcebd9
* wip * Initial draft of Seal HA docs * nav data * Fix env var name * title * Note partially wrapped values and disabled seal participation * Update website/data/docs-nav-data.json Co-authored-by: Steven Clark <steven.clark@hashicorp.com> * correct initial upgrade limitation * Add note about shamir seals and migration * fix nav json * snapshot note * availability note * seal-backend-status * Add a couple more clarifying statements * header typo * correct initial upgrade wording * Update website/content/docs/configuration/seal/seal-ha.mdx Co-authored-by: Steven Clark <steven.clark@hashicorp.com> * Update website/content/docs/concepts/seal.mdx Co-authored-by: Steven Clark <steven.clark@hashicorp.com> --------- Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
48 lines
967 B
Plaintext
48 lines
967 B
Plaintext
---
|
|
layout: api
|
|
page_title: /sys/seal-backend-status - HTTP API
|
|
description: The `/sys/seal-backend-status` endpoint is used to check the status of each seal backend.
|
|
---
|
|
|
|
# `/sys/seal-backend-status`
|
|
|
|
The `/sys/seal-backend-status` endpoint is used to display the status of
|
|
each backing seal, namely whether each backend is healthy.
|
|
|
|
## Seal Backend Status
|
|
|
|
This endpoint returns the seal status of the Vault. This is an unauthenticated
|
|
endpoint.
|
|
|
|
| Method | Path |
|
|
| :----- | :------------------------- |
|
|
| `GET` | `/sys/seal-backend-status` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ curl \
|
|
http://127.0.0.1:8200/v1/sys/seal-backend-status
|
|
```
|
|
|
|
### Sample response
|
|
|
|
|
|
```json
|
|
{
|
|
"healthy": false,
|
|
"unhealthy_since": "2023-09-22T08:34:11Z",
|
|
"backends": [
|
|
{
|
|
"name": "hsm",
|
|
"healthy": true
|
|
},
|
|
{
|
|
"name": "transit",
|
|
"healthy": false,
|
|
"unhealthy_since": "2023-09-22T08:34:11Z"
|
|
}
|
|
]
|
|
}
|
|
```
|