Create or update auto-follow patterns

Create or update auto-follow patterns Added in 6.5.0

PUT /_ccr/auto_follow/{name}

Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.

This API can also be used to update auto-follow patterns. NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.

External documentation

Path parameters

name string Required

The name of the collection of auto-follow patterns.

application/json

Body Required

remote_cluster string Required

The remote cluster containing the leader indices to match against.
follow_index_pattern string
leader_index_patterns array[string]
leader_index_exclusion_patterns array[string]
max_outstanding_read_requests number

The maximum number of outstanding reads requests from the remote cluster.
settings object

Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).
Hide settings attribute Show settings attribute object
- * object Additional properties
  
  Additional properties are allowed.
max_outstanding_write_requests number

The maximum number of outstanding reads requests from the remote cluster.
read_poll_timeout string

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
max_read_request_operation_count number

The maximum number of operations to pull per read from the remote cluster.
max_read_request_size number | string

One of:
_types:ByteSize number _types:ByteSize string
max_retry_delay string

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
max_write_buffer_count number

The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.
max_write_buffer_size number | string

One of:
_types:ByteSize number _types:ByteSize string
max_write_request_operation_count number

The maximum number of operations per bulk write request executed on the follower.
max_write_request_size number | string

One of:
_types:ByteSize number _types:ByteSize string

Responses

200 application/json
Hide response attribute Show response attribute object
- acknowledged boolean Required
  
  For a successful response, this value is always true. On failure, an exception is returned instead.

PUT /_ccr/auto_follow/{name}

curl \
 -X PUT http://api.example.com/_ccr/auto_follow/{name} \
 -H "Content-Type: application/json" \
 -d '{"remote_cluster":"string","follow_index_pattern":"string","leader_index_patterns":["string"],"leader_index_exclusion_patterns":["string"],"max_outstanding_read_requests":42.0,"settings":{"additionalProperty1":{},"additionalProperty2":{}},"max_outstanding_write_requests":42.0,"read_poll_timeout":"string","max_read_request_operation_count":42.0,"":42.0,"max_retry_delay":"string","max_write_buffer_count":42.0,"max_write_request_operation_count":42.0}'

Request examples

{
  "remote_cluster": "string",
  "follow_index_pattern": "string",
  "leader_index_patterns": [
    "string"
  ],
  "leader_index_exclusion_patterns": [
    "string"
  ],
  "max_outstanding_read_requests": 42.0,
  "settings": {
    "additionalProperty1": {},
    "additionalProperty2": {}
  },
  "max_outstanding_write_requests": 42.0,
  "read_poll_timeout": "string",
  "max_read_request_operation_count": 42.0,
  "": 42.0,
  "max_retry_delay": "string",
  "max_write_buffer_count": 42.0,
  "max_write_request_operation_count": 42.0
}

Response examples (200)

{
  "acknowledged": true
}