Key Management Service API, REST: SymmetricKey.ListVersions
Returns the list of versions of the specified symmetric KMS key.
HTTP request
GET https://kms.api.cloud.yandex.net/kms/v1/keys/{keyId}/versions
Path parameters
Field |
Description |
keyId |
string Required field. ID of the symmetric KMS key to list versions for. |
Query parameters
Field |
Description |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
Response
HTTP Code: 200 - OK
{
"keyVersions": [
{
"id": "string",
"keyId": "string",
"status": "string",
"algorithm": "string",
"createdAt": "string",
"primary": "boolean",
"destroyAt": "string",
"hostedByHsm": "boolean"
}
],
"nextPageToken": "string"
}
Field |
Description |
keyVersions[] |
List of versions for the specified symmetric KMS key. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number |
SymmetricKeyVersion
Symmetric KMS key version: metadata about actual cryptographic data.
Field |
Description |
id |
string ID of the key version. |
keyId |
string ID of the symmetric KMS key that the version belongs to. |
status |
enum (Status) Status of the key version.
|
algorithm |
enum (SymmetricAlgorithm) Encryption algorithm that should be used when using the key version to encrypt plaintext.
|
createdAt |
string (date-time) Time when the key version was created. String in RFC3339 To work with values in this field, use the APIs described in the |
primary |
boolean Indication of a primary version, that is to be used by default for all cryptographic |
destroyAt |
string (date-time) Time when the key version is going to be destroyed. Empty unless the status String in RFC3339 To work with values in this field, use the APIs described in the |
hostedByHsm |
boolean Indication of the version that is hosted by HSM. |