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 overrides (all instances)
editSet settings overrides (all instances)
editDEPRECATED (Scheduled to be removed in the next major version): Overrides the settings for all of the instances in the Elasticsearch cluster.
Request
editPUT /api/v1/clusters/elasticsearch/{cluster_id}/instances/settings
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
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
editcurl -XPUT https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
"instance_capacity" : 0,
"storage_multiplier" : 0.1
}
'