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>
57 lines
1.7 KiB
Plaintext
57 lines
1.7 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: /sys/key-status - HTTP API
|
|
description: |-
|
|
The `/sys/key-status` endpoint is used to query info about the current
|
|
encryption key of 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/key-status`
|
|
|
|
@include 'alerts/restricted-root.mdx'
|
|
|
|
The `/sys/key-status` endpoint is used to query info about the current
|
|
encryption key of Vault.
|
|
|
|
## Get encryption key status
|
|
|
|
This endpoint returns information about the current encryption key used by
|
|
Vault.
|
|
|
|
| Method | Path |
|
|
| :----- | :---------------- |
|
|
| `GET` | `/sys/key-status` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ curl \
|
|
--header "X-Vault-Token: ..." \
|
|
--request GET \
|
|
http://127.0.0.1:8200/v1/sys/key-status
|
|
|
|
```
|
|
|
|
### Sample response
|
|
|
|
```json
|
|
{
|
|
"term": 3,
|
|
"install_time": "2015-05-29T14:50:46.223692553-07:00",
|
|
"encryptions": 74718331
|
|
}
|
|
```
|
|
|
|
The `term` parameter is the sequential key number. `install_time` is the
|
|
time that encryption key was installed. `encryptions` is the estimated
|
|
number of encryptions made by the key including those on other cluster
|
|
nodes.
|
|
|
|
Note that the estimated encryption count is aggregated from secondary
|
|
Vault nodes to the primary but not in the other direction. Thus the
|
|
count only accurately reflects the cluster-wide estimate when queried
|
|
on the primary.
|