Set settings overrides | Elastic Cloud Enterprise Reference [2.4]

A newer version is available. For the latest information, see the current release documentation.

› › › ›

« Set settings overrides (all instances) Get settings from this cluster’s keystore »

Set settings overridesedit

Overrides the settings for the specified instances in the Elasticsearch cluster.

Requestedit

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

Path parametersedit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Elasticsearch cluster identifier.
`instance_ids`	`array[string]`	Y	A comma-separated list of instance identifiers.

Query parametersedit

Name	Type	Required	Description
`ignore_missing`	`boolean`; default: `false`	N	When `true` and the instance does not exist, proceeds to the next instance, or treats the instance as an error.
`restart_after_update`	`boolean`; default: `false`	N	After overrides are applied, restarts the instances.

Request bodyedit

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

Responsesedit

200

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

404

(BasicFailedReply) One or more of the instances specified at {instance_ids} could not be found. (code: clusters.instances_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.instances_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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request exampleedit

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

« Set settings overrides (all instances) Get settings from this cluster’s keystore »