This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Modify data streams API
editModify data streams API
editPerforms one or more data stream modification actions in a single atomic operation.
resp = client.indices.modify_data_stream(
actions=[
{
"remove_backing_index": {
"data_stream": "my-logs",
"index": ".ds-my-logs-2099.01.01-000001"
}
},
{
"add_backing_index": {
"data_stream": "my-logs",
"index": "index-to-add"
}
}
],
)
print(resp)
const response = await client.indices.modifyDataStream({
actions: [
{
remove_backing_index: {
data_stream: "my-logs",
index: ".ds-my-logs-2099.01.01-000001",
},
},
{
add_backing_index: {
data_stream: "my-logs",
index: "index-to-add",
},
},
],
});
console.log(response);
POST _data_stream/_modify
{
"actions": [
{
"remove_backing_index": {
"data_stream": "my-logs",
"index": ".ds-my-logs-2099.01.01-000001"
}
},
{
"add_backing_index": {
"data_stream": "my-logs",
"index": "index-to-add"
}
}
]
}
Request
editPOST /_data_stream/_modify
Request body
edit-
actions -
(Required, array of objects) Actions to perform.
Properties of
actionsobjects-
<action> -
(Required, object) The key is the action type. At least one action is required.
Valid
<action>keys-
add_backing_index - Adds an existing index as a backing index for a data stream. The index is hidden as part of this operation.
Adding indices with the
add_backing_indexaction can potentially result in improper data stream behavior. This should be considered an expert level API.-
remove_backing_index - 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.
The object body contains options for the action.
Properties of
<action>-
data_stream - (Required*, string) Data stream targeted by the action.
-
index - (Required*, string) Index for the action.
-
-