Pause a follower

POST /{index}/_ccr/pause_follow

Auth

Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task.

Required authorization

Cluster privileges manage_ccr

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.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /follower_index/_ccr/pause_follow

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.ccr().pauseFollow(p -> p
    .index("follower_index")
);

C# Elasticsearch .NET Client

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

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

A successful response from POST /follower_index/_ccr/pause_follow, which pauses a follower index.

{
  "acknowledged" : true
}