Set snapshot repository

edit

Creates or updates an existing snapshot repository configuration by name.

Request

edit

PUT /api/v1/platform/configuration/snapshots/repositories/{repository_name}

Path parameters

edit
Name Type Required Description

repository_name

string

Y

The name of the snapshot repository configuration.

Query parameters

edit
Name Type Required Description

version

integer

N

Checks for conflicts against the metadata version, then returns the value in the x-cloud-resource-version header.

Request body

edit

(SnapshotRepositoryConfiguration) (required) The Elasticsearch snapshot repository configuration

Responses

edit
200

(RepositoryConfig) New snapshot repository config

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/platform/configuration/snapshots/repositories/{repository_name} \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "settings" : {},
   "type" : "string"
}
'