2017-03-15 06:40:33 +00:00
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
layout: api
|
|
|
|
|
page_title: /sys/key-status - HTTP API
|
2017-03-15 06:40:33 +00:00
|
|
|
description: |-
|
|
|
|
|
The `/sys/key-status` endpoint is used to query info about the current
|
|
|
|
|
encryption key of Vault.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `/sys/key-status`
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :---------------- |
|
|
|
|
|
| `GET` | `/sys/key-status` |
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
```shell-session
|
2018-06-29 13:17:51 +00:00
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request GET \
|
|
|
|
|
http://127.0.0.1:8200/v1/sys/key-status
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
2017-03-15 06:40:33 +00:00
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"term": 3,
|
2021-03-01 16:45:22 +00:00
|
|
|
"install_time": "2015-05-29T14:50:46.223692553-07:00",
|
|
|
|
|
"encryptions": 74718331
|
2017-03-15 06:40:33 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2021-03-01 16:45:22 +00:00
|
|
|
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
|
2021-05-27 17:30:47 +00:00
|
|
|
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.
|
