Pause follower API
editPause follower API
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Pauses a follower index.
Description
editThis 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.
Request
editPOST /<follower_index>/_ccr/pause_follow
Path Parameters
edit-
follower_index(required) - (string) the name of the follower index
Authorization
editIf 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.
Example
editThis example pauses a follower index named follower_index:
POST /follower_index/_ccr/pause_follow
The API returns the following result:
{
"acknowledged" : true
}