Adding the x-yc-apigateway-integration:cloud_datastreams extension
Written by
Updated at July 2, 2025
Management console
-
In the management console
, select the folder in which you created or want to create an API gateway. -
In the list of services, select API Gateway.
-
Select an API gateway or click Create API gateway to create a new one.
-
In the Specification field, click
. -
Specify the following in the field:
- Path: Integration relative path to add to the API Gateway URL. Remember to wrap variables in braces, e.g.,
/static/{function_id}. For more information, see the OpenAPI 3.0 specification. - HTTP method: Method to use to work with the integration.
- Optionally, 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.
- Stream name: Name of the Data Streams stream.
- Optionally, Type of record content: 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 isrequest, the whole request in JSON format will be written to the stream. The default value isbody. - Optionally, Segment key: Segment key. If it is not specified, data will be written to a random segment.
- Path: Integration relative path to add to the API Gateway URL. Remember to wrap variables in braces, e.g.,
-
Click Add.
The Specification field will display the OpenAPI specification with the specified parameter values.