Set settings overrides

Overrides settings for instances belonging to an Elasticsearch cluster.

Request

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

Path Parameters

cluster_id (required)
(string) Identifier for the Elasticsearch cluster
instance_ids (required)
(array[string]) Optional comma-delimited list of instance identifiers of the Elasticsearch cluster, otherwise will apply to all instances

Query Parameters

ignore_missing
(boolean; default: false) If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error
restart_after_update
(boolean; default: false) Whether or not to restart the instances after the overrides are applied.

Request body

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

Responses

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')
449
(BasicFailedReply) When running as an administrator (other than root), sudo is required (code: 'root.needs_sudo')