Update cluster snapshot settings

Any changes in the PATCHed object will be applied to the snapshot settings object. PATCHing existing fields will cause same values to be re-applied. PATCHing a value of 'null' will cause the field to be reverted to its default value or removed if no default value exists


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

Path parameters

cluster_id (required)
(string) Identifier for the Elasticsearch cluster

Query parameters

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

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



(ClusterSnapshotSettings) The cluster snapshot settings were successfully updated


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
(BasicFailedReply) The provided action was prohibited for the given cluster.
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')