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 settingsedit
Overrides cluster curation settings for an Elasticsearch cluster.
Requestedit
PUT /api/v1/clusters/elasticsearch/{cluster_id}/curation/settings
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
If specified then checks for conflicts against the version of the cluster curation settings (returned in 'x-cloud-resource-version' of the GET request) |
Request bodyedit
(ClusterCurationSettings
) (required) The cluster curation settings including updated values
Responsesedit
-
200
-
(
ClusterCurationSettings
) The Elasticsearch cluster curation settings successfully updated.Headers
-
x-cloud-resource-created
(string
) - The date-time when the resource was created (ISO format relative to UTC)
-
x-cloud-resource-last-modified
(string
) - The date-time when the resource was last modified (ISO format relative to UTC)
-
x-cloud-resource-version
(string
) - The resource version, which is used to avoid update conflicts with concurrent operations
-
-
403
-
(
BasicFailedReply
) You are unable to update the Elasticsearch cluster. -
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}/curation/settings \ -u $CLOUD_USER:$CLOUD_KEY \ -H 'Content-Type: application/json' \ -d ' { "specs" : [ { "index_pattern" : "string", "trigger_interval_seconds" : 0 } ] } '