Update cluster curation settings

edit

Overrides cluster curation settings for an Elasticsearch cluster.

Request

edit

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

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parameters

edit
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

edit

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

Responses

edit
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 version of the resource - used to avoid update conflicts from multiple 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.needs_elevated_permissions"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
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
      }
   ]
}
'