open-vault/website/content/api-docs/system/key-status.mdx
Scott Miller 1e1f7eff46
Documentation for barrier autorotation (#11027)
* Documentation for barrier autorotation

* changelog

* 1.7 upgrade notes
2021-03-01 10:45:22 -06:00

48 lines
1 KiB
Plaintext

---
layout: api
page_title: /sys/key-status - HTTP API
sidebar_title: <code>/sys/key-status</code>
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.
| 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.