Get auto-follow patterns

GET /_ccr/auto_follow/{name}
GET /_ccr/auto_follow

Auth

Get cross-cluster replication auto-follow patterns.

More about auto-follow patterns

Required privileges

Cluster privileges manage_ccr

Path parameters

name string optional

The auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections.

Leave it out to use /_ccr/auto_follow.

Query parameters

master_timeout union oneOf · default: 30s: The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.; Values: -1 0

Response

application/json

patterns object[] required

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_ccr/auto_follow/my_auto_follow_pattern

JavaScript Elasticsearch JavaScript Client

const response = await client.ccr.getAutoFollowPattern({
  name: "my_auto_follow_pattern",
});

Python Elasticsearch Python Client

resp = client.ccr.get_auto_follow_pattern(
    name="my_auto_follow_pattern",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_ccr/auto_follow/my_auto_follow_pattern" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ccr().getAutoFollowPattern(g -> g
    .name("my_auto_follow_pattern")
);

C# Elasticsearch .NET Client

var response = await client.CrossClusterReplication
    .GetAutoFollowPatternAsync(d1 => d1
        .Name("my_auto_follow_pattern")
    );

PHP Elasticsearch PHP Client

$resp = $client->ccr()->getAutoFollowPattern([
    "name" => "my_auto_follow_pattern",
]);

Ruby Elasticsearch Ruby Client

response = client.ccr.get_auto_follow_pattern(
  name: "my_auto_follow_pattern"
)

Response

A successful response from GET /_ccr/auto_follow/my_auto_follow_pattern, which gets auto-follow patterns.

{
  "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"
      }
    }
  ]
}