Skip to main content

Delete Key Version Encryption

This API deletes a specific key version of an encryption configuration identified by its unique ID and version number. Once deleted, the key version can no longer be used within the system.


Endpoint Details​

URL /v1/crypto/items/id/versions/version
Method DELETE
Authorization Bearer Token

Request Headers​

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path​

To delete a specific key version of an encryption configuration, use the following request format:

/v1/crypto/items/8471d88d-feda-4d0f-bb39-7f45d8976b94/versions/12

Path Parameters​

ParameterTypeDescription
idUUIDUnique identifier of the encryption configuration
versionIntegerKey version to delete

Response​

Here is an example response after the request has been successfully processed:

Response
{
"success": true
}

Field Descriptions​

FieldTypeDescription
successBooleanIndicates whether the key version was successfully deleted

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing encryption configuration.
  • The version path parameter must reference an existing key version of the configuration.
  • Deleting a key version is permanent and cannot be undone.