Update cluster curation settings

DEPRECATED (Scheduled to be removed in the next major version): Overrides cluster curation settings for an Elasticsearch cluster.

Request

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

Path parameters

Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parameters

Name Type Required Description

version

integer

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

(ClusterCurationSettings) (required) The cluster curation settings including updated values

Responses

200

(ClusterCurationSettings) 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

(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

curl -XPUT https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/curation/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "specs" : [
      {
         "index_pattern" : "string",
         "trigger_interval_seconds" : 0
      }
   ]
}
'