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
editSet settings overrides
editOverrides the settings for the specified instances in the Elasticsearch cluster.
Request
editPUT /api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/settings
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
|
|
Y |
A comma-separated list of instance identifiers. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
After overrides are applied, restarts the instances. |
Request body
edit(ElasticsearchClusterInstanceSettingsOverrides
) (required) The settings to override for the specified instances.
Responses
edit-
200
-
(
ElasticsearchClusterInstanceSettingsOverrides
) Returns the updated settings overrides for the specified instances -
404
-
(
BasicFailedReply
) One or more of the instances specified at {instance_ids} could not be found. (code:clusters.instances_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
editcurl -XPUT {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/settings \ -u $CLOUD_USER:$CLOUD_KEY \ -H 'Content-Type: application/json' \ -d ' { "instance_capacity" : 0, "storage_multiplier" : 0.1 } '