Update data streams

  • POST /_data_stream/_modify
Auth

Performs one or more data stream modification actions in a single atomic operation.

Request body

actions object[] required

Actions to perform.

add_backing_index object

Adds an existing index as a backing index for a data stream. The index is hidden as part of this operation. WARNING: Adding indices with the add_backing_index action can potentially result in improper data stream behavior. This should be considered an expert level API.

data_stream string required

Data stream targeted by the action.

index string required

Index for the action.

remove_backing_index object

Removes a backing index from a data stream. The index is unhidden as part of this operation. A data stream’s write index cannot be removed.

data_stream string required

Data stream targeted by the action.

index string required

Index for the action.

delete_backing_index object

Deletes a backing index from a data stream. A data stream’s write index cannot be deleted because it is the write index.

data_stream string required

Data stream targeted by the action.

index string required

Index for the action.

Response

application/json
acknowledged boolean required

For a successful response, this value is always true. On failure, an exception is returned instead.