Backup Destinations

Before you can create backups, you need at least one storage destination. ServerPlane supports two destination types: S3-compatible object storage and SFTP servers.

Adding a Destination

  1. Navigate to Backups > Destinations from the sidebar.
  2. Click Add Destination.
  3. Enter a Name for the destination (e.g., "Production S3 Bucket").
  4. Select the Type: S3 / S3-Compatible or SFTP.
  5. Fill in the required fields (see below).
  6. Click Create Destination.

S3 / S3-Compatible Storage

Field Description Example
Endpoint The S3 API endpoint. Use s3.amazonaws.com for AWS. For Backblaze B2, Wasabi, MinIO, or other providers, use their respective endpoint. s3.amazonaws.com
Region The bucket's region. us-east-1
Bucket The name of the S3 bucket. my-backups
Path Prefix Optional subfolder path within the bucket. backups
Access Key Your IAM access key ID. AKIA...
Secret Key Your IAM secret access key. (hidden)

SFTP Storage

Field Description Example
Host Hostname or IP address of the SFTP server. backup.example.com
Port SSH port number (defaults to 22). 22
Username The SFTP user to authenticate as. backup_user
Password Password for the SFTP user. (hidden)
Remote Path Absolute path on the remote server where backups will be stored. /backups

Testing a Connection

After creating a destination, click the checkmark icon next to it to test the connection. ServerPlane will attempt to connect and verify write access. A successful test marks the destination as Verified with a green badge.

Editing a Destination

Click the pencil icon next to any destination to open its settings for editing. Update the fields you need and click Update Destination.

Deleting a Destination

  1. Click the trash icon next to the destination.
  2. A confirmation prompt will appear. Click Delete to confirm.

Deleting a destination does not remove any backup data already stored at that location. However, any backup configurations that reference this destination will no longer be able to run.

Destination List

The destinations list shows each entry with its type (S3 or SFTP), key identifier (bucket name or host), the number of backup configurations using it, and its verification status.