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 repositories Get snapshot repository »

› › › ›

Delete snapshot repository

edit

Delete snapshot repository

edit

Deletes the snapshot repository configuration.

Request

edit

DELETE /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
`cleanup_deployments`	`boolean`; default: `false`	N	Removes references to this snapshot repository configuration and disables snapshots on the clusters that were referencing this configuration. If a request is made to delete a repository configuration that has already been deleted and this parameter is set to true and clusters still reference the configuration, then the request will have the side effects of removing references and disabling snapshots for clusters that reference the previously deleted configuration.

Responses

edit

200

(EmptyResponse)

successful operation

202

(EmptyResponse)

Delete snapshot repository config

449

(BasicFailedReply)

elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')

500

(BasicFailedReply)

Failed to delete references and disable snapshots in one or more referencing clusters.

Request example

edit

curl -XDELETE https://{{hostname}}/api/v1/platform/configuration/snapshots/repositories/{repository_name} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Get snapshot repositories Get snapshot repository »