Backups

Preview or run retention using each selected schedule's configured retention days.

post/backups/cleanup

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/backups/cleanup
Auth: HTTP bearer

dry_runboolean

Return the backups selected by retention without deleting anything.

schedule_idinteger nullable

Limit cleanup to one backup schedule.

expected_backup_idsstring[] nullable

Exact candidates returned by the dry run. Execution fails if the retention selection has changed since preview.

Retention cleanup completed

candidate_backup_idsstring[] required

Capped sample of backups selected by the retention policy.

candidate_backup_ids_truncatedboolean required

deletedinteger required

deleted_backup_idsstring[] required

Capped sample of deleted backup UUIDs for audit attribution.

deleted_backup_ids_truncatedboolean required

dry_runboolean required

True when this report is a non-destructive preview.

expiredinteger required

failedinteger required

partially_deleted_backup_idsstring[] required

partially_deleted_backup_ids_truncatedboolean required

schedule_idinteger nullable

Schedule scope, or None when every schedule was considered.