› › ›

Get auto-follow pattern API

Get auto-follow patterns.

Request

GET /_ccr/auto_follow/

GET /_ccr/auto_follow/<auto_follow_pattern_name>

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 gets configured auto-follow patterns. This API will return the specified auto-follow pattern collection.

Path parameters

<auto_follow_pattern_name>: (Optional, string) Specifies the auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections.

Examples

This example retrieves information about an auto-follow pattern collection named my_auto_follow_pattern:

GET /_ccr/auto_follow/my_auto_follow_pattern

The API returns the following result:

{
  "patterns": [
    {
      "name": "my_auto_follow_pattern",
      "pattern": {
        "active": true,
        "remote_cluster" : "remote_cluster",
        "leader_index_patterns" :
        [
          "leader_index*"
        ],
        "leader_index_exclusion_patterns":
        [
          "leader_index_001"
        ],
        "follow_index_pattern" : "{{leader_index}}-follower"
      }
    }
  ]
}

© 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-get-auto-follow-pattern.html