mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
81 lines
2.2 KiB
Text
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-ref-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
|
|
}
|
|
--------------------------------------------------
|