It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Update cluster snapshot settingsedit
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
Requestedit
PATCH /api/v1/clusters/elasticsearch/{cluster_id}/snapshot/settings
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Elasticsearch cluster |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
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 bodyedit
(ClusterSnapshotSettings) (required) The cluster snapshot settings including updated values
Responsesedit
-
200 -
(
ClusterSnapshotSettings) The cluster snapshot settings were successfully updatedHeaders
-
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 exampleedit
curl -XPATCH {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/snapshot/settings \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
"enabled" : true,
"interval" : "string",
"repository" : {
"default" : {},
"reference" : {
"repository_name" : "string"
},
"static" : {
"repository_type" : "string",
"settings" : {}
}
},
"repository_name" : "string",
"suspended" : [
"string"
]
}
'