You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Delete auto-follow pattern APIedit
Delete auto-follow patterns.
Prerequisitesedit
-
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.
Descriptionedit
This API deletes a configured collection of auto-follow patterns.
Path parametersedit
-
<auto_follow_pattern_name>
- (Required, string) Specifies the auto-follow pattern collection to delete.
Query parametersedit
-
master_timeout
-
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout.
Examplesedit
This example deletes an auto-follow pattern collection named
my_auto_follow_pattern
:
response = client.ccr.delete_auto_follow_pattern( name: 'my_auto_follow_pattern' ) puts response
DELETE /_ccr/auto_follow/my_auto_follow_pattern
The API returns the following result:
{ "acknowledged" : true }