Pause follower API

Pauses a follower index.

Request

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.

Examples

This example pauses a follower index named follower_index:

POST /follower_index/_ccr/pause_follow

The API returns the following result:

{
  "acknowledged" : true
}