v1.0.0 Stable

Backup

What This Option Does

Backup module handles backup creation, listing, and cleanup operations.

How Admin Uses This

  1. Open Backup module.
  2. Create backup snapshot when needed.
  3. Review existing backups and retention.
  4. Clean old backups based on policy.

Screenshot Placeholder

Backup Screenshot Placeholder
Add screenshot file at documentaion/assets/images/backoffice-backup.png

Enterprise Technical Specification

Business Capabilities

  • Create backup
  • List backups
  • Cloud upload
  • Backup cleanup
  • Drive config

API Contract Surface

Primary API endpoints used by this module:

  • /api/v1/backup/create
  • /api/v1/backup/list
  • /api/v1/backup/upload-to-drive
  • /api/v1/backup/clean
  • /api/v1/backup/drive-config

Permission Blueprint

Recommended permission keys for production role design:

  • backoffice.backup.view
  • backoffice.backup.create
  • backoffice.backup.delete

Operational Risk and Control Notes

  • Aggressive cleanup may remove required restore points
  • Enable activity logging and include company_id, actor ID, and target entity ID in audit traces.
  • Apply least-privilege principle for create/update/delete actions.

QA Verification Checklist

  • Validate list API load, empty-state behavior, and pagination consistency.
  • Verify create/update/delete response contract (status, message, data).
  • Confirm permission denial responses for unauthorized roles.
  • Test edge inputs and invalid IDs for safe error handling.