Update cluster snapshot settings

edit

DEPRECATED (Scheduled to be removed in the next major version): All changes in the specified object are applied to the snapshot settings according to the JSON Merge Patch processing rules. Omitting existing fields causes the same values to be reapplied. Specifying a null value reverts the field to the default value, or removes the field when no default value exists.

Request

edit

PATCH /api/v1/clusters/elasticsearch/{cluster_id}/snapshot/settings

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

Identifier for the Elasticsearch cluster

Query parameters

edit
Name Type Required Description

version

integer

N

If specified then checks for conflicts against the version of the cluster snapshot settings (returned in 'x-cloud-resource-version' of the GET request)

Request body

edit

(ClusterSnapshotSettings) (required) The cluster snapshot settings including updated values

Responses

edit
200

(ClusterSnapshotSettings) The cluster snapshot 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

edit
curl -XPATCH https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/snapshot/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
   "cron_expression" : "string",
   "enabled" : true,
   "interval" : "string",
   "pending_interval" : "string",
   "repository" : {
      "default" : {},
      "reference" : {
         "repository_name" : "string"
      },
      "static" : {
         "repository_type" : "string",
         "settings" : {}
      }
   },
   "repository_name" : "string",
   "retention" : {
      "max_age" : "string",
      "snapshots" : 0
   },
   "slm" : true,
   "suspended" : [
      "string"
   ],
   "wait_time_after_snapshotting" : "string"
}
'