› › ›

Pause follower API

Pauses a cross-cluster replication follower index.

Request

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

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

POST /<follower_index>/_ccr/pause_follow

Prerequisites

If the Elasticsearch security features are enabled, you must have manage_ccr cluster privileges on the cluster that contains the follower index. For more information, see Security privileges.

Description

This API pauses a follower index. When this API returns, the follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. Pausing and resuming a follower index can be used to change the configuration of the following task.

Path parameters

<follower_index>: (Required, string) The name of the follower index.

Query parameters

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

This example pauses a follower index named follower_index:

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

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

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

POST /follower_index/_ccr/pause_follow

The API returns the following result:

{
  "acknowledged" : true
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-pause-follow.html