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.
Set snapshot repositoryedit
Creates or updates the snapshot repository configuration.
Requestedit
PUT /api/v1/platform/configuration/snapshots/repositories/{repository_name}
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The name of the snapshot repository configuration. |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Checks for conflicts against the metadata version, then returns the value in the |
Request bodyedit
(SnapshotRepositoryConfiguration) (required) The Elasticsearch snapshot repository configuration
Responsesedit
-
200 -
(
RepositoryConfig) The snapshot repository configuration update or creation succeeded. -
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 -XPUT {{hostname}}/api/v1/platform/configuration/snapshots/repositories/{repository_name} \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
"settings" : {},
"type" : "string"
}
'