upstream/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-04-15 22:19:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
vault/website/source/docs/http/system/seal-status.html.md
Seth Vargo efd532536f
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-16 09:46:49 -07:00

1.1 KiB
Raw Blame History

layout page_title sidebar_current description
http /sys/seal-status - HTTP API docs-http-system-seal-status 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 Produces
GET /sys/seal-status 200 application/json

Sample Request

$ curl \
    https://vault.rocks/v1/sys/seal-status

Sample Response

The "t" parameter is the threshold, and "n" is the number of shares.

{
  "sealed": true,
  "t": 3,
  "n": 5,
  "progress": 2,
  "version": "0.6.2"
}

Sample response when Vault is unsealed.

{
  "sealed": false,
  "t": 3,
  "n": 5,
  "progress": 0,
  "version": "0.6.2",
  "cluster_name": "vault-cluster-d6ec3c7f",
  "cluster_id": "3e8b3fec-3749-e056-ba41-b62a63b997e8"
}