You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Unfollow APIedit
Converts a follower index to a regular index.
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have
manage_follow_indexindex privileges for the follower index. For more information, see Security privileges.
Descriptionedit
This API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. This enables the index to treated as a regular index. The follower index must be paused and closed before invoking the unfollow API.
Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.
Path parametersedit
-
<follower_index> - (Required, string) The name of the follower index.
Query parametersedit
-
master_timeout -
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s. Can also be set to-1to indicate that the request should never timeout.
Examplesedit
This example converts follower_index from a follower index to a regular index:
response = client.ccr.unfollow( index: 'follower_index' ) puts response
POST /follower_index/_ccr/unfollow
The API returns the following result:
{
"acknowledged" : true
}