open-vault/website/source/docs/http/system/key-status.html.md
Seth Vargo 19b2b049c3
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

912 B

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

Sample Request

Sample Response

{
  "term": 3,
  "install_time": "2015-05-29T14:50:46.223692553-07:00"
}

The term parameter is the sequential key number, and install_time is the time that encryption key was installed.