Pause auto-follow pattern API
Pauses an auto-follow pattern.
Request
POST /_ccr/auto_follow/<auto_follow_pattern_name>/pause
Prerequisites
- 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
This API pauses an auto-follow pattern. When this API returns, the auto-follow pattern is inactive and ignores any new index created on the remote cluster that matches any of the auto-follow’s patterns. Paused auto-follow patterns appear with the active field set to false in the GET auto-follow patterns API.
You can resume auto-following with the resume auto-follow pattern API. Once resumed, the auto-follow pattern is active again and automatically configure follower 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) Name of the auto-follow pattern to pause.
Examples
This example pauses an auto-follow pattern named my_auto_follow_pattern:
POST /_ccr/auto_follow/my_auto_follow_pattern/pause
The API returns the following result:
{
"acknowledged" : true
}
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/ccr-pause-auto-follow-pattern.html
