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)
editOverrides settings for all instances belonging to an Elasticsearch cluster.
Request
editPUT /api/v1/clusters/elasticsearch/{cluster_id}/instances/settings
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parameters
editName | 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') -
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 example
editcurl -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 } '