pbs_group_delete
Delete an entire backup group and all its snapshots from a Proxmox Backup Server datastore. Use with caution—this operation is irreversible and removes all recovery points.
Instructions
MUTATION: delete an ENTIRE backup group including ALL its snapshots.
RISK_HIGH — bulk-destructive: one call removes every recovery point for this guest/host in this namespace; strictly more destructive than pbs_snapshot_delete (one snapshot) and the same class as pbs_namespace_delete(delete_groups=True). No undo. Check pbs_groups_list / pbs_snapshots_list first — the PLAN deliberately does not pull that content in itself. Dry-run by default; confirm=True executes (DELETE /admin/datastore/{store}/groups) and returns {"status": "ok", "result": {removed-groups, removed-snapshots, protected-snapshots}} — a SYNCHRONOUS stats object, not a task UPID; verify the counters, especially protected-snapshots when error_on_protected=False (a nonzero value means a PARTIAL delete). Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ns | No | Namespace; omit for the root namespace. | |
| store | Yes | PBS datastore name. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the deletion. | |
| backup_id | Yes | Backup group ID whose ENTIRE group (all snapshots) will be deleted. | |
| backup_type | Yes | Backup type: vm, ct, or host. | |
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. | |
| error_on_protected | No | Upstream default TRUE: fail if the group contains any protected snapshot. False = delete all UNPROTECTED snapshots, keep protected ones, and SUCCEED as a partial delete. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |