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.
Resume auto-follow pattern API
editResume auto-follow pattern API
editResumes a cross-cluster replication auto-follow pattern.
Request
editPOST /_ccr/auto_follow/<auto_follow_pattern_name>/resume
Prerequisites
edit-
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.
Description
editThis API resumes an auto-follow pattern that has been paused with the pause auto-follow pattern API. When this API returns, the auto-follow pattern will resume configuring following indices for newly created indices on the remote cluster that match its patterns. Remote indices created while the pattern was paused will also be followed, unless they have been deleted or closed in the meantime.
Path parameters
edit-
<auto_follow_pattern_name> - (Required, string) Specifies the name of the auto-follow pattern to resume.
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-1to indicate that the request should never timeout.
Examples
editThis example resumes the activity of a paused auto-follow pattern
named my_auto_follow_pattern:
resp = client.ccr.resume_auto_follow_pattern(
name="my_auto_follow_pattern",
)
print(resp)
response = client.ccr.resume_auto_follow_pattern( name: 'my_auto_follow_pattern' ) puts response
const response = await client.ccr.resumeAutoFollowPattern({
name: "my_auto_follow_pattern",
});
console.log(response);
POST /_ccr/auto_follow/my_auto_follow_pattern/resume
The API returns the following result:
{
"acknowledged" : true
}