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.

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.

About cross-cluster replication

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

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

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

{
  "acknowledged" : true
}

Unfollow an index

Required authorization

Authentication

Path parameters

Query parameters

Response