Key Management Service API, REST: SymmetricKey.Get
Returns the specified symmetric KMS key.
To get the list of available symmetric KMS keys, make a SymmetricKeyService.List request.
HTTP request
GET https://kms.api.cloud.yandex.net/kms/v1/keys/{keyId}
Path parameters
Field |
Description |
keyId |
string Required field. ID of the symmetric KMS key to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"status": "string",
"primaryVersion": {
"id": "string",
"keyId": "string",
"status": "string",
"algorithm": "string",
"createdAt": "string",
"primary": "boolean",
"destroyAt": "string",
"hostedByHsm": "boolean"
},
"defaultAlgorithm": "string",
"rotatedAt": "string",
"rotationPeriod": "string",
"deletionProtection": "boolean"
}
A symmetric KMS key that may contain several versions of the cryptographic material.
Field |
Description |
id |
string ID of the key. |
folderId |
string ID of the folder that the key belongs to. |
createdAt |
string (date-time) Time when the key was created. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the key. |
description |
string Description of the key. |
labels |
string Custom labels for the key as |
status |
enum (Status) Current status of the key.
|
primaryVersion |
Primary version of the key, used as the default for all encrypt/decrypt operations, |
defaultAlgorithm |
enum (SymmetricAlgorithm) Default encryption algorithm to be used with new versions of the key.
|
rotatedAt |
string (date-time) Time of the last key rotation (time when the last version was created). String in RFC3339 To work with values in this field, use the APIs described in the |
rotationPeriod |
string (duration) Time period between automatic key rotations. |
deletionProtection |
boolean Flag that inhibits deletion of the key |
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. |