Keys

Delete encryption key

Permanently removes an encryption key from the organization. This action cannot be undone and will prevent any future data decryption operations that depend on this key. Ensure all data encrypted with this key is either migrated or no longer needed before deletion. Only available in enterprise deployments for enhanced security management.

delete/api/{org_id}/cipher_keys/{key_name}

Request

Path parameters

key_namestring required

name of the key to delete

org_idstring required

Response

Success

codeinteger required
error_detailstring nullable
hintstring nullable

One-line guidance on how to fix the error (agent self-correction, D4).

idstring nullable
messagestring required
namestring nullable
suggestionsstring[] nullable

Closest valid alternatives for a mistyped field/function name.

trace_idstring nullable
warningsstring[] nullable

Problems with a request that succeeded anyway. Distinct from hint, which explains a failure: these accompany a 200, and the caller is entitled to have meant it.

Changes

No recorded changes to this operation across all 1 revision of this API.