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.

« Create follower API Resume follower API »

› › ›

Pause follower API

edit

Pause follower API

edit

Pauses a cross-cluster replication follower index.

Request

edit

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

edit

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

edit

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

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 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
}

« Create follower API Resume follower API »