This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Resume follower API Forget follower API »

› › ›

Unfollow API

edit

Unfollow API

edit

Converts a cross-cluster replication follower index to a regular index.

Request

edit

resp = client.ccr.unfollow(
    index="<follower_index>",
)
print(resp)

const response = await client.ccr.unfollow({
  index: "<follower_index>",
});
console.log(response);

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.

Query parameters

edit

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 -1 to indicate that the request should never timeout.

Examples

edit

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

resp = client.ccr.unfollow(
    index="follower_index",
)
print(resp)

response = client.ccr.unfollow(
  index: 'follower_index'
)
puts response

const response = await client.ccr.unfollow({
  index: "follower_index",
});
console.log(response);

POST /follower_index/_ccr/unfollow

The API returns the following result:

{
  "acknowledged" : true
}

« Resume follower API Forget follower API »