Set settings overrides (all instances)edit

DEPRECATED (Scheduled to be removed in the next major version): Overrides the settings for all of the instances in the Elasticsearch cluster.

Requestedit

PUT /api/v1/clusters/elasticsearch/{cluster_id}/instances/settings

Path parametersedit

Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parametersedit

Name Type Required Description

restart_after_update

boolean; default: false

N

After overrides are applied, restarts the instances.

Request bodyedit

(ElasticsearchClusterInstanceSettingsOverrides) (required) The settings to override for the instances

Responsesedit

200

(ElasticsearchClusterInstanceSettingsOverrides) Returns the updated settings overrides for the specified instances

404

(BasicFailedReply) The cluster specified at {cluster_id} could not be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response

Request exampleedit

curl -XPUT https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "instance_capacity" : 0,
   "storage_multiplier" : 0.1
}
'