Yandex Cloud
Search
Discuss with expertTry it for free
  • Customer Stories
  • Documentation
  • Blog
  • All Services
    • Cloud Interconnect
    • Cloud Backup
    • Cloud Registry
    • Yandex AI Studio
    • Compute Cloud
    • Object Storage
    • Managed Service for Kubernetes®
    • Yandex BareMetal
    • Smart Web Security
    • Security Deck
    • Managed Service for PostgreSQL
    • Managed Service for ClickHouse®
    • Monium
    • Cloud CDN
    • Network Load Balancer
    • Virtual Private Cloud
    • Cloud DNS
    • Application Load Balancer
    • Yandex Cloud Video
    • Stackland
    • Yandex Cloud Router
    • Yandex Managed Service for Trino
    • Managed Service for MySQL®
    • Managed Service for Valkey™
    • Managed Service for Apache Spark™
    • Yandex StoreDoc
    • Managed Service for OpenSearch
    • Managed Service for Apache Kafka®
    • Data Transfer
    • Yandex MPP Analytics Engine for PostgreSQL
    • Yandex Managed Service for Apache Airflow®
    • Data Processing
    • Yandex MetaData Hub
    • Managed Service for YDB
    • Managed Service for Sharded PostgreSQL
    • Managed Service for YTsaurus
    • Yandex WebSQL
    • DataLens
    • Yandex Search API
    • SpeechSense
    • SpeechKit
    • DataSphere
    • Vision OCR
    • Translate
    • Yandex Identity Hub
    • Key Management Service
    • Certificate Manager
    • Yandex Lockbox
    • Audit Trails
    • SmartCaptcha
    • Cloud Desktop
    • SourceCraft Code Assistant
    • Container Registry
    • Managed Service for GitLab
    • Managed Service for Prometheus®
    • Cloud Functions
    • API Gateway
    • Yandex Cloud Postbox
    • Message Queue
    • Serverless Integrations
    • IoT Core
    • Data Streams
    • Serverless Containers
    • Cloud Notification Service
    • Yandex Query
    • Identity and Access Management
    • Yandex Cloud Console
    • Resource Manager
    • Yandex Cloud Billing
    • Yandex Cloud Quota Manager
    • Cloud Apps
  • System Status
  • Marketplace
    • Featured
    • Infrastructure & Network
    • Data Platform
    • AI for business
    • Security
    • DevOps tools
    • Serverless
    • Monitoring & Resources
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
    • Price calculator
    • Pricing plans
  • Customer Stories
  • Documentation
  • Blog
© 2026 Direct Cursus Technology L.L.C.
Yandex Key Management Service
  • Getting started
  • Access management
  • Pricing policy
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • Encrypt
        • Decrypt
        • ReEncrypt
        • GenerateDataKey
  • Monitoring metrics
  • Audit Trails events
  • FAQ

In this article:

  • gRPC request
  • SymmetricEncryptRequest
  • SymmetricEncryptResponse
  1. API reference
  2. gRPC
  3. SymmetricCrypto
  4. Encrypt

Key Management Service API, gRPC: SymmetricCryptoService.Encrypt

Written by
Yandex Cloud
Updated at December 9, 2025
View in Markdown
  • gRPC request
  • SymmetricEncryptRequest
  • SymmetricEncryptResponse

Encrypts given plaintext with the specified key.

gRPC requestgRPC request

rpc Encrypt (SymmetricEncryptRequest) returns (SymmetricEncryptResponse)

SymmetricEncryptRequestSymmetricEncryptRequest

{
  "key_id": "string",
  "version_id": "string",
  "aad_context": "bytes",
  "plaintext": "bytes"
}

Field

Description

key_id

string

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

The maximum string length in characters is 50.

version_id

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.

aad_context

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

bytes

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

The maximum string length in characters is 32768.

SymmetricEncryptResponseSymmetricEncryptResponse

{
  "key_id": "string",
  "version_id": "string",
  "ciphertext": "bytes"
}

Field

Description

key_id

string

Required field. ID of the symmetric KMS key that was used for encryption.

The maximum string length in characters is 50.

version_id

string

ID of the key version that was used for encryption.

The maximum string length in characters is 50.

ciphertext

bytes

Resulting ciphertext.

Was the article helpful?

Previous
Overview
Next
Decrypt
© 2026 Direct Cursus Technology L.L.C.