Create or update an autoscaling policy

PUT /_autoscaling/policy/{name}

Auth

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

Path parameters

name string required: Name of the autoscaling policy

Query parameters

master_timeout string · default: 30s: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
timeout string · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Request body

roles string[] required
deciders map string to object required: Decider settings.; Reference

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/my_autoscaling_policy
{
  "roles" : [ "data_hot" ],
  "deciders": {
    "fixed": {
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.autoscaling.putAutoscalingPolicy({
  name: "my_autoscaling_policy",
  policy: {
    roles: ["data_hot"],
    deciders: {
      fixed: {},
    },
  },
});

Python Elasticsearch Python Client

resp = client.autoscaling.put_autoscaling_policy(
    name="my_autoscaling_policy",
    policy={
        "roles": [
            "data_hot"
        ],
        "deciders": {
            "fixed": {}
        }
    },
)

curl Shell

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

Java Elasticsearch Java Client

client.autoscaling().putAutoscalingPolicy(p -> p
    .name("my_autoscaling_policy")
    .policy(po -> po
        .roles("data_hot")
        .deciders("fixed", JsonData.fromJson("{}"))
    )
);

PHP Elasticsearch PHP Client

$resp = $client->autoscaling()->putAutoscalingPolicy([
    "name" => "my_autoscaling_policy",
    "body" => [
        "roles" => array(
            "data_hot",
        ),
        "deciders" => [
            "fixed" => new ArrayObject([]),
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.perform_request(
  "PUT",
  "/_autoscaling/policy/my_autoscaling_policy",
  {},
  {
    "roles": [
      "data_hot"
    ],
    "deciders": {
      "fixed": {}
    }
  },
  { "Content-Type": "application/json" },
)

Response

{
  "acknowledged": true
}

Path parameters

Query parameters

Request body { }

Response

Request body