Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex API Gateway
  • Getting started
    • Resource relationships
    • Networking
      • Overview
        • Static response
        • Access over HTTP
        • Cloud Functions
        • Serverless Containers
        • Smart Web Security
        • Object Storage
        • DataSphere
        • Data Streams
        • Message Queue
        • Managed Service for YDB
      • Greedy parameters
      • Generic HTTP method
      • Authorization using a Cloud Functions function
      • Authorization using a JWT
      • WebSocket protocol support
      • Data validation
      • CORS
      • Specification parameterization
      • Canary release
      • Request rate limit
      • Response code replacement
      • Transformation of response and request bodies
    • Quotas and limits
  • Access management
  • Pricing policy
  • Terraform reference
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • FAQ

In this article:

  • Supported parameters
  • Extension specification
  1. Concepts
  2. Specification extensions
  3. Integration options
  4. Data Streams

x-yc-apigateway-integration:cloud_datastreams extension

Written by
Yandex Cloud
Updated at December 5, 2024
  • Supported parameters
  • Extension specification

The x-yc-apigateway-integration:cloud_datastreams extension enables you to access Yandex Data Streams to run operations on streams. Currently, the only supported operation is PutRecord.

You can add an extension to a specification using the specification constructor.

Supported parametersSupported parameters

The table below lists the parameters specific to API Gateway API gateways. You can find the description of other parameters in the OpenAPI 3.0 specification.

Parameter Type Description
action string Operation in progress. Possible values: PutRecord.
stream_name string Data Streams stream name.
partition_key string This is an optional parameter. Shard key. If it is not specified, the writing operation will be performed to a random segment. The parameters are subsituted into partition_key.
payload_format_type string This is an optional parameter. It determines what is to be written. If the value is body, only the request body will be written to the stream. If the value is request, the whole request in JSON format will be written to the stream. The default value is body.
service_account_id string Service account ID. It is used for authorization when performing Data Streams stream operations. If you omit the parameter, the service_account_id top-level parameter value will be used.

Extension specificationExtension specification

Specification example:

  /pets-stream/{petId}:
    post:
      x-yc-apigateway-integration:
        type: cloud_datastreams
        action: PutRecord
        stream_name: /ru-central1/b1v1emj927uv********/ett01h3uz7qm********/pets-stream
        partition_key: '{petId}'
        service_account_id: ajeqvh23fi2********
      parameters:
      - description: petId
        explode: false
        in: path
        name: petId
        required: true
        schema:
          type: string
        style: simple

Was the article helpful?

Previous
DataSphere
Next
Message Queue
© 2025 Direct Cursus Technology L.L.C.