New

The executive guide to generative AI

Read more

Unfollow API

edit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Converts a follower index to a regular index.

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.

Request

edit
POST /<follower_index>/_ccr/unfollow

Path Parmeters

edit
follower_index (required)
(string) the name of the follower index

Authorization

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.

Example

edit

This example converts follower_index from a follower index to a regular index:

POST /follower_index/_ccr/unfollow

The API returns the following result:

{
  "acknowledged" : true
}
Was this helpful?
Feedback