Creates a new named collection of auto-follow patterns against a specified remote cluster Added in 6.5.0

PUT /_ccr/auto_follow/{name}

Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.

Path parameters

  • name string Required

    The name of the collection of auto-follow patterns.

application/json

Body Required

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
}