IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get autoscaling capacity API Get autoscaling policy API »

› › ›

Delete autoscaling policy API

edit

Delete autoscaling policy API

edit

This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

Delete autoscaling policy.

Request

edit

DELETE /_autoscaling/policy/<name>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage_autoscaling cluster privilege to use this API.
If the operator privileges feature is enabled, only operator users can use this API.

Description

edit

This API deletes an autoscaling policy with the provided name.

Examples

edit

This example deletes an autoscaling policy named my_autoscaling_policy.

response = client.autoscaling.delete_autoscaling_policy(
  name: 'my_autoscaling_policy'
)
puts response

DELETE /_autoscaling/policy/my_autoscaling_policy

The API returns the following result:

{
  "acknowledged": true
}

This example deletes all autoscaling policies.

response = client.autoscaling.delete_autoscaling_policy(
  name: '*'
)
puts response

DELETE /_autoscaling/policy/*

The API returns the following result:

{
  "acknowledged": true
}

« Get autoscaling capacity API Get autoscaling policy API »