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)edit
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) The updated settings overrides are retrieved. -
404 -
(
BasicFailedReply) The {cluster_id} can't be found. (code: 'clusters.cluster_not_found') -
449 -
(
BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPUT {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/settings \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
"instance_capacity" : 0,
"storage_multiplier" : 0.1
}
'