Unfollow an index

Auth

Convert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. The follower index must be paused and closed before you call the unfollow API.

Note

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.

Read the reference documentation

Required authorization

Index privileges manage_follow_index

Path parameters

index string required

The name of the follower index.

Query parameters

master_timeout string · default: 30s

The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

Response

application/json
acknowledged boolean required

For a successful response, this value is always true. On failure, an exception is returned instead.