› › ›

Delete auto-follow pattern API

Delete cross-cluster replication auto-follow patterns.

Request

resp = client.ccr.delete_auto_follow_pattern(
    name="<auto_follow_pattern_name>",
)
print(resp)

const response = await client.ccr.deleteAutoFollowPattern({
  name: "<auto_follow_pattern_name>",
});
console.log(response);

DELETE /_ccr/auto_follow/<auto_follow_pattern_name>

Prerequisites

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.

Description

This API deletes a configured collection of auto-follow patterns.

Path parameters

<auto_follow_pattern_name>: (Required, string) Specifies the auto-follow pattern collection to delete.

Query parameters

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.

Examples

This example deletes an auto-follow pattern collection named my_auto_follow_pattern:

resp = client.ccr.delete_auto_follow_pattern(
    name="my_auto_follow_pattern",
)
print(resp)

response = client.ccr.delete_auto_follow_pattern(
  name: 'my_auto_follow_pattern'
)
puts response

const response = await client.ccr.deleteAutoFollowPattern({
  name: "my_auto_follow_pattern",
});
console.log(response);

DELETE /_ccr/auto_follow/my_auto_follow_pattern

The API returns the following result:

{
  "acknowledged" : true
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-delete-auto-follow-pattern.html