Pause an auto-follow pattern
/_ccr/auto_follow/{name}/pause 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
Parameters
path Path Parameters
| Name | Type |
|---|---|
name
required
The name of the auto-follow pattern to pause. | type TypesName = string |
query Query Parameters
| Name | Type |
|---|---|
master_timeout 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 | type TypesDuration = string | "-1" | "0" |
Responses
acknowledged: boolean;
}