Yandex Cloud
КейсыДокументация
ПрезентацияСвязаться с намиНачать бесплатно
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Сделано на Gravity UI
Проект Яндекса
© 2026 ООО «Яндекс.Облако»
Yandex Key Management Service
  • Начало работы
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Encrypt
        • Decrypt
        • ReEncrypt
        • GenerateDataKey
  • Метрики Monium
  • Аудитные логи Audit Trails
  • Вопросы и ответы
  • Обучающие курсы

В этой статье:

  • HTTP request
  • Path parameters
  • Body parameters
  • Response
  1. Справочник API
  2. REST (англ.)
  3. SymmetricCrypto
  4. Encrypt

Key Management Service API, REST: SymmetricCrypto.Encrypt

Статья создана
Yandex Cloud
Обновлена 9 декабря 2025 г.
Открыть в Markdown
  • HTTP request
  • Path parameters
  • Body parameters
  • Response

Encrypts given plaintext with the specified key.

HTTP requestHTTP request

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

Path parametersPath parameters

Field

Description

keyId

string

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

The maximum string length in characters is 50.

Body parametersBody parameters

{
  "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.

The maximum string length in characters is 50.

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.

The maximum string length in characters is 8192.

plaintext

string (bytes)

Required field. Plaintext to be encrypted.
Should be encoded with base64.

The maximum string length in characters is 32768.

ResponseResponse

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.

The maximum string length in characters is 50.

versionId

string

ID of the key version that was used for encryption.

The maximum string length in characters is 50.

ciphertext

string (bytes)

Resulting ciphertext.

Была ли статья полезна?

Предыдущая
Overview
Следующая
Decrypt
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Сделано на Gravity UI
Проект Яндекса
© 2026 ООО «Яндекс.Облако»