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
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex API Gateway
  • Getting started
    • All guides
    • Creating an API gateway
      • Overview
      • Cloud Functions
      • Static response
      • Object Storage
      • Serverless Containers
      • Access over HTTP
      • Message Queue
      • Data Streams
      • Managed Service for YDB
      • DataSphere
      • Yandex Foundation Models
      • Yandex Workflows
    • Viewing operations with service resources
  • Access management
  • Pricing policy
  • Terraform reference
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • FAQ
  1. Step-by-step guides
  2. Specification constructor
  3. Data Streams

Adding the x-yc-apigateway-integration:cloud_datastreams extension

Written by
Yandex Cloud
Updated at January 22, 2025
Management console
  1. In the management console, select the folder in which you created or want to create an API gateway.

  2. In the list of services, select API Gateway.

  3. Select an API gateway or click Create API gateway to create a new one.

  4. In the Specification field, click .

  5. Specify the following in the field:

    • Path: Relative path to the integration that will be added to API Gateway URL. Specify variables in curly braces, e.g., /static/{function_id}. For more information, see the OpenAPI 3.0 specification.
    • HTTP method: Method that will be used to work with the integration.
    • (Optional) Service account: Service account used for authorization when performing Data Streams stream operations. If you do not have a service account, create one.
    • Operation: Operation in progress.
    • Data Streams stream name: Data Streams data stream name.
    • (Optional) Record content type: Record content type. 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.
    • (Optional) Segment key: Segment key. If not specified, a random segment will be written to.
  6. Click Add.

The Specification field will display the OpenAPI specification with the specified parameter values.

See alsoSee also

  • x-yc-apigateway-integration:cloud_datastreams extension

Was the article helpful?

Previous
Message Queue
Next
Managed Service for YDB
Yandex project
© 2025 Yandex.Cloud LLC