Verify encryption configuration

Checks stored KMS settings without changing the configuration. A completed check returns ok=false on KMS failure. Legacy Vault configurations return ok=true without a KMS check.

Required permission

Account > Admin > Encryption > Read

Path parameters

encryptionConfigurationId
string required
Name-derived ID of the encryption configuration.

Response body

{object}
Response object.

data
{object} required
Result data.

ok
boolean required
keyRef
string
KMS key reference, when available.
error
string
A safe validation failure summary.

API

CLI

JS Client

POST /v1/encryption/configurations/{encryptionConfigurationId}/verify

POST /v1/teams/{teamId}/encryption/configurations/{encryptionConfigurationId}/verify

Example response

200 OK

Stored configuration verification result.

JSON