Skip to main content

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

HeaderTypeDescription
Content-TypeStringMust 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

ParameterTypeDescription
idUUIDUnique 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

FieldTypeDescription
ring_idStringInternal key ring identifier associated with the encryption configuration
algorithmStringEncryption algorithm used by the configuration
current_versionIntegerCurrent key version of the encryption configuration
min_decrypt_verIntegerMinimum key version that can still be used to decrypt data
versionsArrayList of key versions available for the encryption configuration
versionIntegerKey version number
statusStringCurrent status of the key version
created_atIntegerCreation timestamp of the key version in Unix format
usageIntegerNumber of times the key version has been used
last_used_atIntegerTimestamp of the last time the key version was used, in Unix format
rotation_typeStringType of rotation that generated the key version
totalIntegerTotal number of key versions available
pageIntegerCurrent page number
page_sizeIntegerNumber of records returned per page
last_pageIntegerTotal number of available pages

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing encryption configuration.
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.