IMPORTANT: Version 6.5 of Elasticsearch has passed its maintenance date.
This documentation is no longer being updated. For the latest information, see the current release documentation.
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Get auto-follow patterns.
This API gets configured auto-follow patterns. This API will return the specified auto-follow pattern collection.
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
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.
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:
{
"my_auto_follow_pattern" :
{
"remote_cluster" : "remote_cluster",
"leader_index_patterns" :
[
"leader_index*"
],
"follow_index_pattern" : "{{leader_index}}-follower"
}
}