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.

« 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"')

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} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "settings" : {},
   "type" : "string"
}
'

« Get snapshot repository Platform - Runners »