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.

« Update cluster curation settings Set settings overrides »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.3] ›RESTful API ›API reference ›Clusters - Elasticsearch - CRUD - Configuration

Set settings overrides (all instances)

edit

Set settings overrides (all instances)

edit

Overrides the settings for all of the instances in the Elasticsearch cluster.

Request

edit

PUT /api/v1/clusters/elasticsearch/{cluster_id}/instances/settings

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parameters

edit
Name Type Required Description

restart_after_update

boolean; default: false

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.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
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
}
'
« Update cluster curation settings Set settings overrides »