[role="xpack"]
[testenv="platinum"]
[[ccr-post-resume-follow]]
=== Resume Follower API
++++
Resume Follower
++++
Resumes a follower index.
==== Description
This API resumes a follower index that has been paused either explicitly with
the <> or implicitly due to
execution that can not be retried due to failure during following. When this API
returns, the follower index will resume fetching operations from the leader index.
==== Request
//////////////////////////
[source,js]
--------------------------------------------------
PUT /follower_index/_ccr/follow
{
"remote_cluster" : "remote_cluster",
"leader_index" : "leader_index"
}
POST /follower_index/_ccr/pause_follow
--------------------------------------------------
// CONSOLE
// TESTSETUP
// TEST[setup:remote_cluster_and_leader_index]
[source,js]
--------------------------------------------------
POST /follower_index/_ccr/pause_follow
--------------------------------------------------
// CONSOLE
// TEARDOWN
//////////////////////////
[source,js]
--------------------------------------------------
POST //_ccr/resume_follow
{
}
--------------------------------------------------
// CONSOLE
// TEST[s//follower_index/]
// TEST[s//remote_cluster/]
// TEST[s//leader_index/]
==== Path Parameters
`follower_index` (required)::
(string) the name of the follower index
==== Request Body
include::../follow-request-body.asciidoc[]
==== Example
This example resumes a follower index named `follower_index`:
[source,js]
--------------------------------------------------
POST /follower_index/_ccr/resume_follow
{
"max_read_request_operation_count" : 1024,
"max_outstanding_read_requests" : 16,
"max_read_request_size" : "1024k",
"max_write_request_operation_count" : 32768,
"max_write_request_size" : "16k",
"max_outstanding_write_requests" : 8,
"max_write_buffer_count" : 512,
"max_write_buffer_size" : "512k",
"max_retry_delay" : "10s",
"read_poll_timeout" : "30s"
}
--------------------------------------------------
// CONSOLE
The API returns the following result:
[source,js]
--------------------------------------------------
{
"acknowledged" : true
}
--------------------------------------------------
// TESTRESPONSE