Rotate Encryption Key
This API rotates the encryption key for a specific encryption configuration identified by its unique ID. Rotating a key generates a new key version while retaining previous versions.
Endpoint Details
| URL | /v1/crypto/items/id/rotate |
| Method | POST |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must be application/json |
Request Path
To rotate the encryption key of a specific encryption configuration, use the following request format:
/v1/crypto/items/8471d88d-feda-4d0f-bb39-7f45d8976b94/rotate
Path Parameter
| Parameter | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the encryption configuration whose key is rotated |
Response
Here is an example response after the request has been successfully processed:
Response
{
"new_version": 12
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| new_version | Integer | New key version generated after the encryption key is rotated |
info
- A valid Bearer Token is required to access this endpoint.
- The
idpath parameter must reference an existing encryption configuration. - Rotating a key increments the
current_versionof the encryption configuration. - Previous key versions are retained so that data encrypted with an earlier version can still be decrypted.
- New encryption operations use the latest key version generated by the rotation.