Update cluster curation settingsedit
This endpoint is deprecated and scheduled to be removed in the next major version. Use Elasticsearch index lifecycle management (ILM) instead.
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
-
The cluster curation settings were 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
-
The provided action was prohibited for the given cluster.
-
404
-
The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
-
449
-
elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')
Request exampleedit
curl -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 } ] } '