Key Management Service API, REST: SymmetricCrypto.Encrypt

Written by

Updated at November 26, 2024

Encrypts given plaintext with the specified key.

HTTP request

POST https://kms.yandex/kms/v1/keys/{keyId}:encrypt

Field

Description

keyId

string

Required field. ID of the symmetric KMS key to use for encryption.

{
  "versionId": "string",
  "aadContext": "string",
  "plaintext": "string"
}

Field	Description
versionId	string ID of the key version to encrypt plaintext with. Defaults to the primary version if not specified.
aadContext	string (bytes) Additional authenticated data (AAD context), optional. If specified, this data will be required for decryption with the SymmetricDecryptRequest. Should be encoded with base64.
plaintext	string (bytes) Required field. Plaintext to be encrypted. Should be encoded with base64.

HTTP Code: 200 - OK

{
  "keyId": "string",
  "versionId": "string",
  "ciphertext": "string"
}

Field	Description
keyId	string Required field. ID of the symmetric KMS key that was used for encryption.
versionId	string ID of the key version that was used for encryption.
ciphertext	string (bytes) Resulting ciphertext.