Create an On-Demand Backup

Who this is for

Users who want to take an immediate, one-time backup of a server or site before making changes (e.g., a major update, server migration, or code deployment).


Prerequisites

  • Server is running with SSH connectivity.
  • For snapshot backups: the server's cloud account is connected and functional.

How to Create an On-Demand Backup

  1. Open the server detail → Backups tab.
  2. Click + Create Backup.
  3. Fill in the form:
FieldDescription
Backup typesnapshot, files, database, or full — see KB-05-01: Backup Architecture
SiteOptional — select a specific site to back up, or leave blank for a server-level backup
NoteOptional free-text label (e.g., "Before WP 6.4 upgrade")
RetentionDays to keep this backup (1–365, default 30)
EncryptedToggle to encrypt the backup file at rest
Offsite configOptional — select a cloud storage vault to upload the backup to immediately
  1. Click Create Backup.

The backup job starts immediately. Monitor progress in the Activity Center.


Backup Status After Creation

The backup record appears in the Backups tab with status pendingrunningcompleted (or failed).


Taking a Backup Before a Risky Operation

Best practice: create a full backup with a descriptive note before any risky change:

  • "Before deploying v2.0"
  • "Before upgrading PHP from 8.1 to 8.3"
  • "Before server migration"

This gives you a recovery point that is easy to find in the Backups list.


What Success Looks Like

Backup status shows completed. The size is visible (e.g., "152 MB"). The backup appears in the Backups tab list.


Common Issues and Fixes

IssueLikely causeFix
"SSH_NOT_CONFIGURED"Server has no SSH key configuredSet up SSH — see KB-02-08: SSH Setup and Repair
"INVALID_TYPE"Unrecognized backup typeUse snapshot, files, database, or full only
"INVALID_CONFIG"Offsite config does not exist or is for a different providerRemove the offsite config selection, or verify the storage vault
Backup stuck in "running"SSH dropped during backupCheck Activity Center for error detail. Try again after verifying SSH.
Backup file is 0 bytesNo data found in backup targetFor a site backup, verify the site's document root has files

Related Articles