Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Key Management Service
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Ключ
    • Версия ключа
    • Шифрование данных
  • Концепции
    • Обзор
    • Ключ
    • Версия ключа
    • Шифрование
    • Шифрование по схеме envelope encryption
    • Консистентность ключей
    • Аппаратный модуль безопасности (HSM)
    • Квоты и лимиты
  • Практические руководства
    • Все руководства
    • Шифрование данных
      • Какой способ шифрования выбрать?
      • Шифрование с помощью CLI и API Yandex Cloud
      • Шифрование с помощью SDK Yandex Cloud
      • Шифрование с помощью AWS Encryption SDK
      • Шифрование с помощью Google Tink
    • Шифрование секретов в Managed Service for Kubernetes
    • Управление ключами KMS с Hashicorp Terraform
    • Шифрование секретов в Hashicorp Terraform
    • Auto Unseal в Hashicorp Vault
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • SymmetricCryptoService
      • SymmetricKeyService
      • OperationService
    • REST (англ.)
      • Overview
      • SymmetricCrypto
        • Overview
        • decrypt
        • encrypt
        • generateDataKey
        • reEncrypt
      • SymmetricKey
        • Overview
        • cancelVersionDestruction
        • create
        • delete
        • get
        • list
        • listAccessBindings
        • listOperations
        • listVersions
        • rotate
        • scheduleVersionDestruction
        • setAccessBindings
        • setPrimaryVersion
        • update
        • updateAccessBindings
  • Вопросы и ответы
  1. Справочник API
  2. REST (англ.)
  3. SymmetricCrypto
  4. encrypt

Key Management Service API, REST: SymmetricCrypto.encrypt

Статья создана
Yandex Cloud
  • HTTP request
  • Path parameters
  • Body parameters
  • Response

Encrypts given plaintext with the specified key.

HTTP request

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

Path parameters

Parameter Description
keyId

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

The maximum string length in characters is 50.

Body 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 (byte)

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 (byte)

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

The maximum string length in characters is 32768.

Response

HTTP Code: 200 - OK

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

Required. 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 (byte)

Resulting ciphertext.

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

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • HTTP request
  • Path parameters
  • Body parameters
  • Response