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
editUpdate cluster curation settings
editDEPRECATED (Scheduled to be removed in the next major version): Overrides cluster curation settings for an Elasticsearch cluster.
Request
editPUT /api/v1/clusters/elasticsearch/{cluster_id}/curation/settings
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parameters
editName | 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 body
edit(ClusterCurationSettings
) (required) The cluster curation settings including updated values
Responses
edit-
200
-
(
ClusterCurationSettings
) The cluster curation settings were successfully updatedHeaders
-
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
) The provided action was prohibited for the given cluster. -
404
-
(
BasicFailedReply
) The cluster specified by {cluster_id} cannot 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
editcurl -XPUT https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/curation/settings \ -H "Authorization: ApiKey $ECE_API_KEY" \ -d ' { "specs" : [ { "index_pattern" : "string", "trigger_interval_seconds" : 0 } ] } '