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

« Update cluster curation settings Set settings overrides »

› › › ›

Set settings overrides (all instances)

edit

Set settings overrides (all instances)

edit

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

Overrides the settings for all of the instances in the Elasticsearch cluster.

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Elasticsearch cluster identifier.

Query parameters

edit

Name	Type	Required	Description
`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 instances

Responses

edit

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 example

edit

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
}
'

« Update cluster curation settings Set settings overrides »