Add DeleteBackup command to ServerUtil

This commit is contained in:
Wouter Tinus
2026-04-10 17:43:30 +02:00
parent eebb283b7c
commit 7cb8d1055b
3 changed files with 78 additions and 1 deletions
@@ -0,0 +1,62 @@
// Copyright (C) 2025, The Duplicati Team
// https://duplicati.com, hello@duplicati.com
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
using System.CommandLine;
using System.CommandLine.NamingConventionBinder;
namespace Duplicati.CommandLine.ServerUtil.Commands;
public static class DeleteBackup
{
public static Command Create() =>
new Command("delete", "Deletes a backup")
{
new Argument<string>("backup", "The backup to delete, either ID or exact name (case-insensitive)") {
Arity = ArgumentArity.ExactlyOne
},
new Option<bool>(name: "--delete-remote-files", description: "Delete remote files associated with the backup", getDefaultValue: () => false),
new Option<bool>(name: "--delete-local-db", description: "Delete local database associated with the backup", getDefaultValue: () => false),
new Option<bool>(name: "--force", description: "Force deletion even if the backup is running at the moment", getDefaultValue: () => false),,
new Option<bool>("--quiet", "Do not print progress messages") {
IsRequired = false
}
}
.WithHandler(CommandHandler.Create<Settings, OutputInterceptor, string, bool, bool, bool, bool>(async (settings, output, backup, deleteRemoteFiles, deleteLocalDb, force, quiet) =>
{
var connection = await settings.GetConnection(output);
var matchingBackup = (await connection.ListBackups())
.FirstOrDefault(b => string.Equals(b.Name, backup, StringComparison.OrdinalIgnoreCase) || string.Equals(b.ID, backup));
if (matchingBackup == null)
throw new UserReportedException("No backup found with supplied ID or name");
if (!quiet)
output.AppendConsoleMessage($"Deleting backup {matchingBackup.Name} (ID: {matchingBackup.ID})");
await connection.DeleteBackup(matchingBackup.ID, deleteRemoteFiles: deleteRemoteFiles, deleteLocalDb: deleteLocalDb, force: force);
if (!quiet)
output.AppendConsoleMessage($"Deleted");
output.SetResult(true);
}));
}
@@ -421,6 +421,20 @@ public class Connection
await EnsureSuccessStatusCodeWithParsing(response);
}
/// <summary>
/// Deletes a backup
/// </summary>
/// <param name="backupId">The ID of the backup</param>
/// <param name="deleteRemoteFiles">Whether to delete remote files</param>
/// <param name="deleteLocalDb">Whether to delete the local database</param>
/// <param name="force">Whether to force the deletion even if the backup is running at the moment</param>
/// <returns>The task</returns>
public async Task DeleteBackup(string backupId, bool deleteRemoteFiles, bool deleteLocalDb, bool force)
{
var response = await client.DeleteAsync($"backup/{Uri.EscapeDataString(backupId)}?delete-remote-files={deleteRemoteFiles}&delete-local-db={deleteLocalDb}&force={force}");
await EnsureSuccessStatusCodeWithParsing(response);
}
/// <summary>
/// Gets the server state
/// </summary>
+2 -1
View File
@@ -46,6 +46,7 @@ public static class Program
{
Pause.Create(),
Resume.Create(),
DeleteBackup.Create(),
ListBackups.Create(),
RunBackup.Create(),
Login.Create(),
@@ -97,4 +98,4 @@ public static class Program
.UseAdditionalHelpAliases()
.Build().InvokeAsync(args);
}
}
}