Delete snapshot repository

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

Deletes the snapshot repository configuration.

Path parameters

Query parameters

  • cleanup_deployments boolean

    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.

    Default value is false.

Responses

  • 200

    successful operation

    Additional properties are allowed.
  • 202

    Delete snapshot repository config

    Additional properties are allowed.
  • 500

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

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
DELETE /platform/configuration/snapshots/repositories/{repository_name} 
curl \
 -X DELETE https://{{hostname}}/api/v1/platform/configuration/snapshots/repositories/{repository_name}
Response examples (200) 
{}
Response examples (202) 
{}
Response examples (500) 
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}