Docs
Elasticsearch Guide [8.1] » REST APIs » Cross-cluster replication APIs » Resume auto-follow pattern API
« Pause auto-follow pattern API Data stream APIs »

Resume auto-follow pattern API

Resumes an auto-follow pattern.

Request

POST /_ccr/auto_follow/<auto_follow_pattern_name>/resume

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 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

<auto_follow_pattern_name>
(Required, string) Specifies the name of the auto-follow pattern to resume.

Examples

This example resumes the activity of a paused auto-follow pattern named my_auto_follow_pattern:

POST /_ccr/auto_follow/my_auto_follow_pattern/resume

The API returns the following result:

{
  "acknowledged" : true
}
« Pause auto-follow pattern API Data stream APIs »