You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Pause follower APIedit
Pauses a follower index.
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have
manage_ccrcluster privileges on the cluster that contains the follower index. For more information, see Security privileges.
Descriptionedit
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 parametersedit
-
<follower_index> - (Required, string) The name of the follower index.
Query parametersedit
-
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-1to indicate that the request should never timeout.
Examplesedit
This example pauses a follower index named follower_index:
response = client.ccr.pause_follow( index: 'follower_index' ) puts response
POST /follower_index/_ccr/pause_follow
The API returns the following result:
{
"acknowledged" : true
}