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.
Requestedit
PUT /api/v1/clusters/elasticsearch/{cluster_id}/instances/settings
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
After overrides are applied, restarts the instances. |
Request bodyedit
(ElasticsearchClusterInstanceSettingsOverrides
) (required) The settings to override for the instances
Responsesedit
-
200
-
(
ElasticsearchClusterInstanceSettingsOverrides
)Returns the updated settings overrides for the specified instances
-
404
-
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
-
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/settings \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "instance_capacity" : 0, "storage_multiplier" : 0.1 } '