IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get snapshot repository Platform - Runners »

› › › ›

Set snapshot repository

edit

Set snapshot repository

edit

Creates or updates the snapshot repository configuration.

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.unauthorized.rbac.elevated_permissions_required"')

Request example

edit

curl -XPUT https://{{hostname}}/api/v1/platform/configuration/snapshots/repositories/{repository_name} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
   "settings" : {},
   "type" : "string"
}
'

« Get snapshot repository Platform - Runners »