Elastic Stack (ELK Stack) Ccr API

openapi: 3.2.0
info:
  title: Elasticsearch Request & Response Specification Ccr API
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
tags:
- name: ccr
paths:
  /_ccr/auto_follow/{name}:
    get:
      tags:
      - ccr
      summary: Get auto-follow patterns
      description: 'Get cross-cluster replication auto-follow patterns.


        ## Required authorization


        * Cluster privileges: `manage_ccr`

        '
      externalDocs:
        description: More about auto-follow patterns
        url: https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-auto-follow-pattern.html
      operationId: ccr-get-auto-follow-pattern-1
      parameters:
      - $ref: '#/components/parameters/ccr.get_auto_follow_pattern-name'
      - $ref: '#/components/parameters/ccr.get_auto_follow_pattern-master_timeout'
      responses:
        '200':
          $ref: '#/components/responses/ccr.get_auto_follow_pattern-200'
      x-state: Generally available; Added in 6.5.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
    put:
      tags:
      - ccr
      summary: Create or update auto-follow patterns
      description: '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.'
      externalDocs:
        description: More about auto-follow patterns
        url: https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-put-auto-follow-pattern.html
      operationId: ccr-put-auto-follow-pattern
      parameters:
      - in: path
        name: name
        description: The name of the collection of auto-follow patterns.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Name'
        style: simple
      - in: query
        name: master_timeout
        description: Period to wait for a connection to the master node.
        deprecated: false
        schema:
          default: 30s
          allOf:
          - $ref: '#/components/schemas/_types.Duration'
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                remote_cluster:
                  description: The remote cluster containing the leader indices to match against.
                  type: string
                follow_index_pattern:
                  description: The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.
                  allOf:
                  - $ref: '#/components/schemas/_types.IndexPattern'
                leader_index_patterns:
                  description: An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.
                  allOf:
                  - $ref: '#/components/schemas/_types.IndexPatterns'
                leader_index_exclusion_patterns:
                  description: An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.
                  allOf:
                  - $ref: '#/components/schemas/_types.IndexPatterns'
                max_outstanding_read_requests:
                  description: The maximum number of outstanding reads requests from the remote cluster.
                  default: 12.0
                  type: number
                settings:
                  description: Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).
                  type: object
                  additionalProperties:
                    type: object
                max_outstanding_write_requests:
                  description: The maximum number of outstanding reads requests from the remote cluster.
                  default: 9.0
                  type: number
                read_poll_timeout:
                  description: The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.
                  default: 1m
                  allOf:
                  - $ref: '#/components/schemas/_types.Duration'
                max_read_request_operation_count:
                  description: The maximum number of operations to pull per read from the remote cluster.
                  default: 5120.0
                  type: number
                max_read_request_size:
                  description: The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.
                  default: 32mb
                  allOf:
                  - $ref: '#/components/schemas/_types.ByteSize'
                max_retry_delay:
                  description: The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.
                  default: 500ms
                  allOf:
                  - $ref: '#/components/schemas/_types.Duration'
                max_write_buffer_count:
                  description: 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.
                  default: 2147483647.0
                  type: number
                max_write_buffer_size:
                  description: The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.
                  default: 512mb
                  allOf:
                  - $ref: '#/components/schemas/_types.ByteSize'
                max_write_request_operation_count:
                  description: The maximum number of operations per bulk write request executed on the follower.
                  default: 5120.0
                  type: number
                max_write_request_size:
                  description: The maximum total bytes of operations per bulk write request executed on the follower.
                  default: 9223372036854775807b
                  allOf:
                  - $ref: '#/components/schemas/_types.ByteSize'
              required:
              - remote_cluster
            examples:
              PutAutoFollowPatternRequestExample1:
                description: 'Run `PUT /_ccr/auto_follow/my_auto_follow_pattern` to creates an auto-follow pattern.

                  '
                value: "{\n  \"remote_cluster\" : \"remote_cluster\",\n  \"leader_index_patterns\" :\n  [\n    \"leader_index*\"\n  ],\n  \"follow_index_pattern\" : \"{{leader_index}}-follower\",\n  \"settings\": {\n    \"index.number_of_replicas\": 0\n  },\n  \"max_read_request_operation_count\" : 1024,\n  \"max_outstanding_read_requests\" : 16,\n  \"max_read_request_size\" : \"1024k\",\n  \"max_write_request_operation_count\" : 32768,\n  \"max_write_request_size\" : \"16k\",\n  \"max_outstanding_write_requests\" : 8,\n  \"max_write_buffer_count\" : 512,\n  \"max_write_buffer_size\" : \"512k\",\n  \"max_retry_delay\" : \"10s\",\n  \"read_poll_timeout\" : \"30s\"\n}"
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_types.AcknowledgedResponseBase'
              examples:
                PutAutoFollowPatternResponseExample1:
                  description: A successful response for creating an auto-follow pattern.
                  value: "{\n  \"acknowledged\": true\n}"
      x-state: Generally available; Added in 6.5.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
    delete:
      tags:
      - ccr
      summary: Delete auto-follow patterns
      description: 'Delete a collection of cross-cluster replication auto-follow patterns.


        ## Required authorization


        * Cluster privileges: `manage_ccr`

        '
      externalDocs:
        description: More about auto-follow patterns
        url: https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-delete-auto-follow-pattern.html
      operationId: ccr-delete-auto-follow-pattern
      parameters:
      - in: path
        name: name
        description: The auto-follow pattern collection to delete.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Name'
        style: simple
      - in: query
        name: master_timeout
        description: '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.'
        deprecated: false
        schema:
          default: 30s
          allOf:
          - $ref: '#/components/schemas/_types.Duration'
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_types.AcknowledgedResponseBase'
              examples:
                DeleteAutoFollowPatternResponseExample1:
                  description: A successful response from `DELETE /_ccr/auto_follow/my_auto_follow_pattern`, which deletes an auto-follow pattern.
                  value: "{\n  \"acknowledged\" : true\n}"
      x-state: Generally available; Added in 6.5.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /{index}/_ccr/follow:
    put:
      tags:
      - ccr
      summary: Create a follower
      description: 'Create a cross-cluster replication follower index that follows a specific leader index.

        When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.'
      operationId: ccr-follow
      parameters:
      - in: path
        name: index
        description: The name of the follower index.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.IndexName'
        style: simple
      - in: query
        name: master_timeout
        description: Period to wait for a connection to the master node.
        deprecated: false
        schema:
          default: 30s
          allOf:
          - $ref: '#/components/schemas/_types.Duration'
        style: form
      - in: query
        name: wait_for_active_shards
        description: 'Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be

          active.

          A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the

          remote Lucene segment files to the follower index.'
        deprecated: false
        schema:
          default: '0'
          allOf:
          - $ref: '#/components/schemas/_types.WaitForActiveShards'
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data_stream_name:
                  description: If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.
                  type: string
                leader_index:
                  description: The name of the index in the leader cluster to follow.
                  allOf:
                  - $ref: '#/components/schemas/_types.IndexName'
                max_outstanding_read_requests:
                  description: The maximum number of outstanding reads requests from the remote cluster.
                  type: number
                max_outstanding_write_requests:
                  description: The maximum number of outstanding write requests on the follower.
                  type: number
                max_read_request_operation_count:
                  description: The maximum number of operations to pull per read from the remote cluster.
                  type: number
                max_read_request_size:
                  description: The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.
                  allOf:
                  - $ref: '#/components/schemas/_types.ByteSize'
                max_retry_delay:
                  description: 'The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when

                    retrying.'
                  allOf:
                  - $ref: '#/components/schemas/_types.Duration'
                max_write_buffer_count:
                  description: '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.'
                  type: number
                max_write_buffer_size:
                  description: 'The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will

                    be deferred until the total bytes of queued operations goes below the limit.'
                  allOf:
                  - $ref: '#/components/schemas/_types.ByteSize'
                max_write_request_operation_count:
                  description: The maximum number of operations per bulk write request executed on the follower.
                  type: number
                max_write_request_size:
                  description: The maximum total bytes of operations per bulk write request executed on the follower.
                  allOf:
                  - $ref: '#/components/schemas/_types.ByteSize'
                read_poll_timeout:
                  description: 'The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.

                    When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.

                    Then the follower will immediately attempt to read from the leader again.'
                  allOf:
                  - $ref: '#/components/schemas/_types.Duration'
                remote_cluster:
                  description: The remote cluster containing the leader index.
                  type: string
                settings:
                  description: Settings to override from the leader index.
                  allOf:
                  - $ref: '#/components/schemas/indices._types.IndexSettings'
              required:
              - leader_index
              - remote_cluster
            examples:
              CreateFollowIndexRequestExample1:
                description: Run `PUT /follower_index/_ccr/follow?wait_for_active_shards=1` to create a follower index named `follower_index`.
                value: "{\n  \"remote_cluster\" : \"remote_cluster\",\n  \"leader_index\" : \"leader_index\",\n  \"settings\": {\n    \"index.number_of_replicas\": 0\n  },\n  \"max_read_request_operation_count\" : 1024,\n  \"max_outstanding_read_requests\" : 16,\n  \"max_read_request_size\" : \"1024k\",\n  \"max_write_request_operation_count\" : 32768,\n  \"max_write_request_size\" : \"16k\",\n  \"max_outstanding_write_requests\" : 8,\n  \"max_write_buffer_count\" : 512,\n  \"max_write_buffer_size\" : \"512k\",\n  \"max_retry_delay\" : \"10s\",\n  \"read_poll_timeout\" : \"30s\"\n}"
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  follow_index_created:
                    type: boolean
                  follow_index_shards_acked:
                    type: boolean
                  index_following_started:
                    type: boolean
                required:
                - follow_index_created
                - follow_index_shards_acked
                - index_following_started
              examples:
                CreateFollowIndexResponseExample1:
                  description: A successful response from `PUT /follower_index/_ccr/follow?wait_for_active_shards=1`.
                  value: "{\n  \"follow_index_created\" : true,\n  \"follow_index_shards_acked\" : true,\n  \"index_following_started\" : true\n}"
      x-state: Generally available; Added in 6.5.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /{index}/_ccr/info:
    get:
      tags:
      - ccr
      summary: Get follower information
      description: 'Get information about all cross-cluster replication follower indices.

        For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      externalDocs:
        description: About cross-cluster replication
        url: https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-follow-info.html
      operationId: ccr-follow-info
      parameters:
      - in: path
        name: index
        description: A comma-delimited list of follower index patterns.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Indices'
        style: simple
      - in: query
        name: master_timeout
        description: '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.'
        deprecated: false
        schema:
          default: 30s
          allOf:
          - $ref: '#/components/schemas/_types.Duration'
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  follower_indices:
                    type: array
                    items:
                      $ref: '#/components/schemas/ccr.follow_info.FollowerIndex'
                required:
                - follower_indices
              examples:
                FollowInfoResponseExample1:
                  summary: An active follower index
                  description: A successful response from `GET /follower_index/_ccr/info` when the follower index is active.
                  value: "{\n  \"follower_indices\": [\n    {\n      \"follower_index\": \"follower_index\",\n      \"remote_cluster\": \"remote_cluster\",\n      \"leader_index\": \"leader_index\",\n      \"status\": \"active\",\n      \"parameters\": {\n        \"max_read_request_operation_count\": 5120,\n        \"max_read_request_size\": \"32mb\",\n        \"max_outstanding_read_requests\": 12,\n        \"max_write_request_operation_count\": 5120,\n        \"max_write_request_size\": \"9223372036854775807b\",\n        \"max_outstanding_write_requests\": 9,\n        \"max_write_buffer_count\": 2147483647,\n        \"max_write_buffer_size\": \"512mb\",\n        \"max_retry_delay\": \"500ms\",\n        \"read_poll_timeout\": \"1m\"\n      }\n    }\n  ]\n}"
                FollowInfoResponseExample2:
                  summary: A paused follower index
                  description: A successful response from `GET /follower_index/_ccr/info` when the follower index is paused.
                  value: "{\n  \"follower_indices\": [\n    {\n      \"follower_index\": \"follower_index\",\n      \"remote_cluster\": \"remote_cluster\",\n      \"leader_index\": \"leader_index\",\n      \"status\": \"paused\"\n    }\n  ]\n}"
      x-state: Generally available; Added in 6.7.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /{index}/_ccr/stats:
    get:
      tags:
      - ccr
      summary: Get follower stats
      description: 'Get cross-cluster replication follower stats.

        The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      externalDocs:
        description: About cross-cluster replication
        url: https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-follow-stats.html
      operationId: ccr-follow-stats
      parameters:
      - in: path
        name: index
        description: A comma-delimited list of index patterns.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Indices'
        style: simple
      - in: query
        name: timeout
        description: 'The period to wait for a response.

          If no response is received before the timeout expires, the request fails and returns an error.'
        deprecated: false
        schema:
          default: 30s
          allOf:
          - $ref: '#/components/schemas/_types.Duration'
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  indices:
                    description: An array of follower index statistics.
                    type: array
                    items:
                      $ref: '#/components/schemas/ccr._types.FollowIndexStats'
                required:
                - indices
              examples:
                FollowIndexStatsResponseExample1:
                  description: A successful response from `GET /follower_index/_ccr/stats`, which retrieves follower stats.
                  value: "{\n  \"indices\" : [\n    {\n      \"index\" : \"follower_index\",\n      \"total_global_checkpoint_lag\" : 256,\n      \"shards\" : [\n        {\n          \"remote_cluster\" : \"remote_cluster\",\n          \"leader_index\" : \"leader_index\",\n          \"follower_index\" : \"follower_index\",\n          \"shard_id\" : 0,\n          \"leader_global_checkpoint\" : 1024,\n          \"leader_max_seq_no\" : 1536,\n          \"follower_global_checkpoint\" : 768,\n          \"follower_max_seq_no\" : 896,\n          \"last_requested_seq_no\" : 897,\n          \"outstanding_read_requests\" : 8,\n          \"outstanding_write_requests\" : 2,\n          \"write_buffer_operation_count\" : 64,\n          \"follower_mapping_version\" : 4,\n          \"follower_settings_version\" : 2,\n          \"follower_aliases_version\" : 8,\n          \"total_read_time_millis\" : 32768,\n          \"total_read_remote_exec_time_millis\" : 16384,\n          \"successful_read_requests\" : 32,\n          \"failed_read_requests\" : 0,\n          \"operations_read\" : 896,\n          \"bytes_read\" : 32768,\n          \"total_write_time_millis\" : 16384,\n          \"write_buffer_size_in_bytes\" : 1536,\n          \"successful_write_requests\" : 16,\n          \"failed_write_requests\" : 0,\n          \"operations_written\" : 832,\n          \"read_exceptions\" : [ ],\n          \"time_since_last_read_millis\" : 8\n        }\n      ]\n    }\n  ]\n}"
      x-state: Generally available; Added in 6.5.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /{index}/_ccr/forget_follower:
    post:
      tags:
      - ccr
      summary: Forget a follower
      description: 'Remove the cross-cluster replication follower retention leases from the leader.


        A following index takes out retention leases on its leader index.

        These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.

        When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.

        However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.

        While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.

        This API exists to enable manually removing the leases when the unfollow API is unable to do so.


        NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.

        The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.'
      externalDocs:
        description: About cross-cluster replication
        url: https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-forget-follower.html
      operationId: ccr-forget-follower
      parameters:
      - in: path
        name: index
        description: Name of the leader index for which specified follower retention leases should be removed
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.IndexName'
        style: simple
      - in: query
        name: timeout
        description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
        deprecated: false
        schema:
          default: 30s
          allOf:
          - $ref: '#/components/schemas/_types.Duration'
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                follower_cluster:
                  type: string
                follower_index:
                  allOf:
                  - $ref: '#/components/schemas/_types.IndexName'
                follower_index_uuid:
                  allOf:
                  - $ref: '#/components/schemas/_types.Uuid'
                leader_remote_cluster:
                  type: string
            examples:
              ForgetFollowerIndexRequestExample1:
                description: Run `POST /<leader_index>/_ccr/forget_follower`.
                value: "{\n  \"follower_cluster\" : \"<follower_cluster>\",\n  \"follower_index\" : \"<follower_index>\",\n  \"follower_index_uuid\" : \"<follower_index_uuid>\",\n  \"leader_remote_cluster\" : \"<leader_remote_cluster>\"\n}"
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  _shards:
                    allOf:
                    - $ref: '#/components/schemas/_types.ShardStatistics'
                required:
                - _shards
              examples:
                ForgetFollowerIndexResponseExample1:
                  description: 'A successful response for removing the follower retention leases from the leader index.

                    '
                  value: "{\n  \"_shards\" : {\n    \"total\" : 1,\n    \"successful\" : 1,\n    \"failed\" : 0,\n    \"failures\" : [ ]\n  }\n}"
      x-state: Generally available; Added in 6.7.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_ccr/auto_follow:
    get:
      tags:
      - ccr
      summary: Get auto-follow patterns
      description: 'Get cross-cluster replication auto-follow patterns.


        ## Required authorization


        * Cluster privileges: `manage_ccr`

        '
      externalDocs:
        description: More about auto-follow patterns
        url: https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-auto-follow-pattern.html
      operationId: ccr-get-auto-follow-pattern
      parameters:
      - $ref: '#/components/parameters/ccr.get_auto_follow_pattern-master_timeout'
      responses:
        '200':
          $ref: '#/components/responses/ccr.get_auto_follow_pattern-200'
      x-state: Generally available; Added in 6.5.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_ccr/auto_follow/{name}/pause:
    post:
      tags:
      - ccr
      summary: Pause an auto-follow pattern
      description: 'Pause a cross-cluster replication auto-follow pattern.

        When the API returns, the auto-follow pattern is inactive.

        New indices that are created on the remote cluster and match the auto-follow patterns are ignored.


        You can resume auto-following with the resume auto-follow pattern API.

        When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.

        Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.


        ## Required authorization


        * Cluster privileges: `manage_ccr`

        '
      externalDocs:
        description: More about auto-follow patterns
        url: https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-pause-auto-follow-pattern.html
      operationId: ccr-pause-auto-follow-pattern
      parameters:
      - in: path
        name: name
        description: The name of the auto-follow pattern to pause.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Name'
        style: simple
      - in: query
        name: master_timeout
        description: '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.'
        deprecated: false
        schema:
          default: 30s
          allOf:
          - $ref: '#/components/schemas/_types.Duration'
        style: form
      responses:
        '200':
          description: ''
          content

# --- truncated at 32 KB (528 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-ccr-api-openapi.yml