Key Info Encryption
This API returns key information for a specific encryption configuration identified by its unique ID, including its key ring, algorithm, current version, and the minimum version required for decryption.
Endpoint Details
| URL | /v1/crypto/items/id/key-info |
| Method | GET |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must be application/json |
Request Path
To retrieve the key information of a specific encryption configuration, use the following request format:
/v1/crypto/items/8471d88d-feda-4d0f-bb39-7f45d8976b94/key-info
Path Parameter
| Parameter | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the encryption configuration |
Response
Here is an example response after the request has been successfully processed:
Response
{
"ring_id": "crypto/8471d88d-feda-4d0f-bb39-7f45d8976b94",
"algorithm": "RSA1024",
"current_version": 12,
"min_decrypt_ver": 1
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| ring_id | String | Internal key ring identifier associated with the encryption configuration |
| algorithm | String | Encryption algorithm used by the configuration |
| current_version | Integer | Current key version of the encryption configuration |
| min_decrypt_ver | Integer | Minimum key version that can still be used to decrypt data |
info
- A valid Bearer Token is required to access this endpoint.
- The
idpath parameter must reference an existing encryption configuration. - The
current_versionreflects the latest key version used for new encryption operations. - Data encrypted with any key version between
min_decrypt_verandcurrent_versioncan still be decrypted.