This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Delete auto-follow pattern API
editDelete auto-follow pattern API
editDelete cross-cluster replication auto-follow patterns.
Request
editresp = 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
edit-
If the Elasticsearch security features are enabled, you must have
manage_ccrcluster privileges on the cluster that contains the follower index. For more information, see Security privileges.
Description
editThis API deletes a configured collection of auto-follow patterns.
Path parameters
edit-
<auto_follow_pattern_name> - (Required, string) Specifies the auto-follow pattern collection to delete.
Query parameters
edit-
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-1to indicate that the request should never timeout.
Examples
editThis 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
}