It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Set settings overridesedit
DEPRECATED (Scheduled to be removed in the next major version): 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 |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
|
|
Y |
A comma-separated list of instance identifiers. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
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
-
Request exampleedit
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 } '