Skip to main content

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

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

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

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

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing encryption configuration.
  • The current_version reflects the latest key version used for new encryption operations.
  • Data encrypted with any key version between min_decrypt_ver and current_version can still be decrypted.