Create or update an autoscaling policy

PUT /_autoscaling/policy/{name}

Note

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

Read the reference documentation

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

The API method and path for this request: PUT /_autoscaling/policy/my_autoscaling_policy. It creates my_autoscaling_policy using the fixed autoscaling decider, applying to the set of nodes having (only) the data_hot role.

Console Kibana Dev Tools

PUT /_autoscaling/policy/NAME
{
  "roles" : [ "data_hot" ],
  "deciders": {
    "fixed": {
    }
  }
}

Generated from the API spec

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_autoscaling/policy/${NAME}" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "roles" : [ "data_hot" ],
    "deciders": {
      "fixed": {
      }
    }
  }'

Generated from the API spec

Response

{
  "acknowledged": true
}

Create or update an autoscaling policy

Authentication

Path parameters

Query parameters

Request body

Response

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body