Skip to main content

Get KMS status

get
/api/pvlt/1.0/system/info/kms

Gets the status of the configured KMS.

The role that performs this operation must have the CapKMSReader capability. See Access control for more information about how capabilities are used to control access to operations.

Possible responses

The request is successful.

object required*

The status and type of the default KMS and the KMS for export.

  • kms - object required*
    • status - string required*

      The status of the KMS.

    • type - string required*

      The type of the KMS.

  • kms_export - object
    • status - string required*

      The status of the KMS.

    • type - string required*

      The type of the KMS.

Example
{
"kms": {
"status": "pass",
"type": "AWS"
},
"kms_export": {
"status": "pass",
"type": "AWS"
}
}

Try the API

Authorization

Navigate to the docs of your local Vault installation to try the API directly from there.

Code examples

Example