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.

« Data stream stats API Modify data streams API »

› › ›

Promote data stream API

edit

Promote data stream API

edit

The purpose of the promote data stream API is to turn a data stream that is replicated by CCR into a regular data stream.

Via CCR Auto Following, a data stream from a remote cluster can be replicated to the local cluster. These data streams can’t be rolled over in the local cluster. Only if the upstream data stream rolls over then these replicated data streams roll over as well. In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.

When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. If this is missing, the data stream will not be able to roll over until a matching index template is created. This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.

resp = client.indices.promote_data_stream(
    name="my-data-stream",
)
print(resp)

response = client.indices.promote_data_stream(
  name: 'my-data-stream'
)
puts response

const response = await client.indices.promoteDataStream({
  name: "my-data-stream",
});
console.log(response);

POST /_data_stream/_promote/my-data-stream

Request

edit

POST /_data_stream/_promote/<data-stream>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage_follow_index cluster privilege to use this API.

Path parameters

edit

<data-stream>: (Required, string) The name of the data stream to promote.

« Data stream stats API Modify data streams API »