You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Promote data stream APIedit
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.
response = client.indices.promote_data_stream( name: 'my-data-stream' ) puts response
POST /_data_stream/_promote/my-data-stream
Requestedit
POST /_data_stream/_promote/<data-stream>
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage_follow_indexcluster privilege to use this API.
Path parametersedit
-
<data-stream> - (Required, string) The name of the data stream to promote.