Unfollow an index

POST /{index}/_ccr/unfollow

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.

info 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.

Required authorization

Index privileges: manage_follow_index

Read the reference documentation

Path Parameters

index string IndexName required: The name of the follower index.

Query Parameters

master_timeout string Duration · 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

Examples

A successful response from POST /follower_index/_ccr/unfollow.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /follower_index/_ccr/unfollow

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X POST "$ELASTICSEARCH_URL/follower_index/_ccr/unfollow" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ccr().unfollow(u -> u
    .index("follower_index")
);

C# Elasticsearch .NET Client

var response = await client.CrossClusterReplication.UnfollowAsync(index: "follower_index");

PHP Elasticsearch PHP Client

$resp = $client->ccr()->unfollow([
    "index" => "follower_index",
]);

Ruby Elasticsearch Ruby Client

response = client.ccr.unfollow(
  index: "follower_index"
)

Response

{
  "acknowledged" : true
}