pbs_snapshot_delete
Delete a specific backup snapshot from a PBS datastore. Dry-run before permanent removal; confirmation required to execute.
Instructions
MUTATION (HIGH): delete a specific backup snapshot (a recovery point) from a PBS datastore. Dry-run by default. Permanent — no undo. confirm=True to execute. Synchronous. To shield a snapshot instead of deleting it use pbs_snapshot_protected_set(protected=True); for bulk retention-based deletion use pbs_prune.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ns | No | Namespace path the snapshot lives in; omit for the root namespace. | |
| store | Yes | PBS datastore name. | |
| confirm | No | Set True to execute; False (default) only returns the dry-run plan. | |
| backup_id | Yes | Backup group ID (e.g. VMID/CTID or host name). | |
| backup_time | Yes | Snapshot timestamp as a Unix epoch integer, identifying the exact backup run. | |
| backup_type | Yes | Backup type of the snapshot: '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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |