Endpoint

/v2/encryption/key-store/status

GET

View the status of at-rest encryption.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "encryption_api_v2_status_response",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "Local",
        "KMS"
      ],
      "description": "Does the cluster connect to a Key Management Server?:\n * `KMS` - ENCRYPTION_TYPE_KMS,\n * `Local` - ENCRYPTION_TYPE_LOCAL"
    },
    "status": {
      "type": "string",
      "enum": [
        "Not Encrypted",
        "Encrypted",
        "Configuration Corrupted",
        "KMS Available",
        "KMS Authentication Error",
        "Cannot connect to KMS server.",
        "KMS Key Not Found",
        "KMS Key Inactive"
      ],
      "description": "Is the Key Management Server accessible?:\n * `Cannot connect to KMS server.` - ENCRYPTION_CONFIG_STATUS_KMS_CANNOT_CONNECT,\n * `Configuration Corrupted` - ENCRYPTION_CONFIG_STATUS_CONFIG_CORRUPTED,\n * `Encrypted` - ENCRYPTION_CONFIG_STATUS_LOCAL,\n * `KMS Authentication Error` - ENCRYPTION_CONFIG_STATUS_KMS_AUTHENTICATION_ERROR,\n * `KMS Available` - ENCRYPTION_CONFIG_STATUS_KMS_AVAILABLE,\n * `KMS Key Inactive` - ENCRYPTION_CONFIG_STATUS_KMS_KEY_INACTIVE,\n * `KMS Key Not Found` - ENCRYPTION_CONFIG_STATUS_KMS_KEY_NOT_FOUND,\n * `Not Encrypted` - ENCRYPTION_CONFIG_STATUS_NOT_ENCRYPTED"
    },
    "ca_cert_expiry": {
      "description": "The expiry date for the Key Management Server Certificate Authority certificate.",
      "type": "string"
    },
    "client_cert_expiry": {
      "description": "The expiry date for the client certificate.",
      "type": "string"
    },
    "last_key_rotation_time": {
      "description": "The time at which the current encryption key became active.",
      "type": "string"
    },
    "last_status_update_time": {
      "description": "The time at which this status of the configuration was last updated.",
      "type": "string"
    }
  }
}