[role="xpack"] [testenv="platinum"] [[ccr-get-auto-follow-pattern]] === Get Auto-Follow Pattern API ++++ Get Auto-Follow Pattern ++++ Get auto-follow patterns. ==== Description This API gets configured auto-follow patterns. This API will return the specified auto-follow pattern collection. ==== Request ////////////////////////// [source,js] -------------------------------------------------- PUT /_ccr/auto_follow/my_auto_follow_pattern { "remote_cluster" : "remote_cluster", "leader_index_patterns" : [ "leader_index*" ], "follow_index_pattern" : "{{leader_index}}-follower" } -------------------------------------------------- // CONSOLE // TEST[setup:remote_cluster] // TESTSETUP [source,js] -------------------------------------------------- DELETE /_ccr/auto_follow/my_auto_follow_pattern -------------------------------------------------- // CONSOLE // TEST // TEARDOWN ////////////////////////// [source,js] -------------------------------------------------- GET /_ccr/auto_follow/ -------------------------------------------------- // CONSOLE [source,js] -------------------------------------------------- GET /_ccr/auto_follow/ -------------------------------------------------- // CONSOLE // TEST[s//my_auto_follow_pattern/] ==== Path Parameters `auto_follow_pattern_name`:: (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 ==== Example This example retrieves information about an auto-follow pattern collection named `my_auto_follow_pattern`: [source,js] -------------------------------------------------- GET /_ccr/auto_follow/my_auto_follow_pattern -------------------------------------------------- // CONSOLE // TEST[setup:remote_cluster] The API returns the following result: [source,js] -------------------------------------------------- { "my_auto_follow_pattern" : { "remote_cluster" : "remote_cluster", "leader_index_patterns" : [ "leader_index*" ], "follow_index_pattern" : "{{leader_index}}-follower" } } -------------------------------------------------- // TESTRESPONSE