IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Resume follower API Forget follower API »

› › ›

Unfollow API

edit

Unfollow API

edit

Converts a follower index to a regular index.

Request

edit

POST /<follower_index>/_ccr/unfollow

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have manage_follow_index index privileges for the follower index. For more information, see Security privileges.

Description

edit

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 parameters

edit

<follower_index>: (Required, string) The name of the follower index.

Examples

edit

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
}

« Resume follower API Forget follower API »