IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

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

› › › ›

Set settings overrides

edit

Set settings overrides

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use set resource instances overrides instead.

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

Request

edit

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

Path parameters

edit

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 parameters

edit

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 body

edit

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

Responses

edit

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

Request example

edit

curl -XPUT https://{{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 »