pbs_snapshot_protected_set
Set or clear the protected flag on a PBS snapshot to shield it from pruning and garbage collection, or re-enable automatic deletion.
Instructions
MUTATION: set or clear the protected flag on a PBS snapshot. RISK IS CONDITIONAL:
protected=True → LOW: shields the snapshot from pruning and GC (protective). protected=False → HIGH: SILENTLY re-enables pruning/GC — this recovery point can now be auto-deleted by the next prune job or GC run. No undo once auto-deleted.
No PBS snapshot primitive for rollback. Dry-run by default. confirm=True to execute.
PUT /admin/datastore/{store}/protected Smoke-confirm: exact path + param names (backup-type, backup-id, backup-time, protected).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ns | No | ||
| store | Yes | ||
| confirm | No | ||
| backup_id | Yes | ||
| protected | Yes | ||
| backup_time | Yes | ||
| backup_type | Yes | ||
| 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 |