Delete snapshot repository

Deletes the snapshot repository configuration.

Request

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

Path parameters

Name Type Required Description

repository_name

string

Y

The name of the snapshot repository configuration.

Query parameters

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

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.

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

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