Get auto-follow patterns Generally available; Added in 6.5.0

GET /_ccr/auto_follow/{name}
Api key auth Basic auth Bearer auth

Get cross-cluster replication auto-follow patterns.

Required authorization

  • Cluster privileges: manage_ccr
External documentation

Path parameters

  • name string Required

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

Query parameters

  • master_timeout string

    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 are -1 or 0.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • patterns array[object] Required
      Hide patterns attributes Show patterns attributes object
      • name string Required
      • pattern object Required
        Hide pattern attributes Show pattern attributes object
        • active boolean Required
        • remote_cluster string Required

          The remote cluster containing the leader indices to match against.

        • follow_index_pattern string
        • leader_index_patterns array[string] Required
        • leader_index_exclusion_patterns array[string] Required
        • max_outstanding_read_requests number Required

          The maximum number of outstanding reads requests from the remote cluster.
GET /_ccr/auto_follow/{name} 
GET /_ccr/auto_follow/my_auto_follow_pattern 
resp = client.ccr.get_auto_follow_pattern( name="my_auto_follow_pattern", )
const response = await client.ccr.getAutoFollowPattern({ name: "my_auto_follow_pattern", });
response = client.ccr.get_auto_follow_pattern( name: "my_auto_follow_pattern" )
$resp = $client->ccr()->getAutoFollowPattern([ "name" => "my_auto_follow_pattern", ]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ccr/auto_follow/my_auto_follow_pattern"
Response examples (200)
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" } } ] }