elasticsearch/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc
David Turner ccbb5badce
Fix support for infinite ?master_timeout (#107050)
Specifying `?master_timeout=-1` on an API which performs a cluster state
update means that the cluster state update task will never time out
while waiting in the pending tasks queue. However this parameter is also
re-used in a few places where a timeout of `-1` means something else,
typically to timeout immediately. This commit fixes those places so that
`?master_timeout=-1` consistently means to wait forever.
2024-04-10 18:32:38 +01:00

81 lines
2.2 KiB
Text

[role="xpack"]
[[ccr-delete-auto-follow-pattern]]
=== Delete auto-follow pattern API
++++
<titleabbrev>Delete auto-follow pattern</titleabbrev>
++++
Delete auto-follow patterns.
[[ccr-delete-auto-follow-pattern-request]]
==== {api-request-title}
//////////////////////////
[source,console]
--------------------------------------------------
PUT /_ccr/auto_follow/my_auto_follow_pattern
{
"remote_cluster" : "remote_cluster",
"leader_index_patterns" :
[
"leader_index"
],
"follow_index_pattern" : "{{leader_index}}-follower"
}
--------------------------------------------------
// TEST[setup:remote_cluster]
// TESTSETUP
//////////////////////////
[source,console]
--------------------------------------------------
DELETE /_ccr/auto_follow/<auto_follow_pattern_name>
--------------------------------------------------
// TEST[s/<auto_follow_pattern_name>/my_auto_follow_pattern/]
[[ccr-delete-auto-follow-pattern-prereqs]]
==== {api-prereq-title}
* If the {es} {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>>.
[[ccr-delete-auto-follow-pattern-desc]]
==== {api-description-title}
This API deletes a configured collection of
<<ccr-auto-follow,auto-follow patterns>>.
[[ccr-delete-auto-follow-pattern-path-parms]]
==== {api-path-parms-title}
`<auto_follow_pattern_name>`::
(Required, string) Specifies the auto-follow pattern collection to delete.
[[ccr-delete-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-delete-auto-follow-pattern-examples]]
==== {api-examples-title}
This example deletes an auto-follow pattern collection named
`my_auto_follow_pattern`:
[source,console]
--------------------------------------------------
DELETE /_ccr/auto_follow/my_auto_follow_pattern
--------------------------------------------------
// TEST[setup:remote_cluster]
The API returns the following result:
[source,console-result]
--------------------------------------------------
{
"acknowledged" : true
}
--------------------------------------------------