List Key Versions Encryption
This API returns the list of key versions for a specific encryption configuration identified by its unique ID, including each version's status, usage, and rotation details.
Endpoint Details
| URL | /v1/crypto/items/id/versions |
| Method | GET |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must be application/json |
Request Path
To retrieve the key versions of a specific encryption configuration, use the following request format:
/v1/crypto/items/e03782b1-0d59-45dd-b7aa-b78711a33afc/versions
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/e03782b1-0d59-45dd-b7aa-b78711a33afc",
"algorithm": "AES256",
"current_version": 2,
"min_decrypt_ver": 1,
"versions": [
{
"version": 2,
"status": "active",
"created_at": 1783502050,
"usage": 1,
"last_used_at": 1783502050,
"rotation_type": "manual"
},
{
"version": 1,
"status": "active",
"created_at": 1782979636,
"usage": 1,
"last_used_at": 1782979636
}
],
"total": 2,
"page": 1,
"page_size": 10,
"last_page": 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 |
| versions | Array | List of key versions available for the encryption configuration |
| version | Integer | Key version number |
| status | String | Current status of the key version |
| created_at | Integer | Creation timestamp of the key version in Unix format |
| usage | Integer | Number of times the key version has been used |
| last_used_at | Integer | Timestamp of the last time the key version was used, in Unix format |
| rotation_type | String | Type of rotation that generated the key version |
| total | Integer | Total number of key versions available |
| page | Integer | Current page number |
| page_size | Integer | Number of records returned per page |
| last_page | Integer | Total number of available pages |
info
- A valid Bearer Token is required to access this endpoint.
- The
idpath parameter must reference an existing encryption configuration. - Unix timestamp fields can be converted to a human-readable date and time format as needed.