Backup API Reference

This page lists all backup API endpoints for teams building integrations or automations against the Breeze Backup system. For UI-based workflows, see the other pages in the Backup section.

Note

All backup endpoints require authentication and are scoped to the caller’s organization. Organization-scoped tokens are automatically restricted to their own data. Partner-scoped tokens work when the partner has access to exactly one organization.

---

Storage Configurations

Method	Path	Description
GET	/backup/configs	List all configurations
POST	/backup/configs	Create a configuration
GET	/backup/configs/:id	Get configuration details
PATCH	/backup/configs/:id	Update configuration fields (shallow-merged)
DELETE	/backup/configs/:id	Delete a configuration
POST	/backup/configs/:id/test	Test storage connectivity

---

Backup Jobs

Method	Path	Description
GET	/backup/jobs	List jobs (filter: status, deviceId, date, from, to)
GET	/backup/jobs/:id	Get job details
POST	/backup/jobs/run/:deviceId	Trigger manual backup
POST	/backup/jobs/:id/cancel	Cancel a running/queued job
GET	/backup/jobs/run-all/preview	Preview a run-all: counts of eligible, offline, and already-running devices
POST	/backup/jobs/run-all	Trigger a manual backup on every device with an assigned backup policy

---

Snapshots

Method	Path	Description
GET	/backup/snapshots	List snapshots (filter: deviceId, configId)
GET	/backup/snapshots/:id	Get snapshot metadata
GET	/backup/snapshots/:id/browse	Browse snapshot file tree

---

Restore Operations

Method	Path	Description
POST	/backup/restore	Initiate a restore (snapshotId, optional deviceId, targetPath)
GET	/backup/restore	List restore jobs (filter: deviceId, snapshotId, status, from, to)
GET	/backup/restore/:id	Get a single restore job with status and result details

---

Dashboard & Metrics

Method	Path	Description
GET	/backup/dashboard	Organization backup summary
GET	/backup/status/:deviceId	Per-device backup status and next scheduled run
GET	/backup/usage-history	Storage usage time series (query: days, 3–90)

---

VSS (Windows)

Method	Path	Description
GET	/backup/vss/status/:deviceId	VSS writer status for a device

---

SQL Server

Method	Path	Description
GET	/backup/mssql/instances	List all discovered instances (org-wide)
GET	/backup/mssql/instances/:deviceId	List instances on a device
POST	/backup/mssql/backup	Back up a database (deviceId, instance, database, backupType, outputPath)
POST	/backup/mssql/restore	Restore a database from a backup snapshot (deviceId, snapshotId, targetDatabase, optional instance, optional noRecovery). Returns 202 with commandId and restoreJobId once the restore is dispatched — see note below

SQL Server and Hyper-V restores are asynchronous (v0.117.0+)

POST /backup/mssql/restore and POST /backup/hyperv/restore return 202 Accepted as soon as the restore command is queued, instead of holding the request open for up to 10 minutes and reporting a failure while the agent was still restoring. The response carries a restoreJobId; poll GET /backup/restore/:id for the terminal status. A device that is offline is rejected with 409.

---

Hyper-V

Method	Path	Description
GET	/backup/hyperv/vms	List VMs (org-wide)
GET	/backup/hyperv/vms/:deviceId	List VMs on a host
POST	/backup/hyperv/backup	Export a VM (deviceId, vmName, exportPath, optional consistencyType)
POST	/backup/hyperv/restore	Import a VM from a backup snapshot (deviceId, snapshotId, optional vmName, optional generateNewId, default true). Returns 202 with commandId and restoreJobId once dispatched
POST	/backup/hyperv/checkpoints/:deviceId/:vmId	Manage VM checkpoints
POST	/backup/hyperv/vm-state/:deviceId/:vmId	Control VM power state

---

VM Restore

Method	Path	Description
POST	/backup/restore/as-vm	Restore a snapshot as a new VM
POST	/backup/restore/instant-boot	Instant boot a VM from snapshot

---

Bare Metal Recovery

Method	Path	Description
POST	/backup/bmr/tokens	Generate recovery token (snapshotId, optional expiresInHours, restoreType, targetConfig)
GET	/backup/bmr/tokens/:id	Get recovery token metadata

Boot Media

Bootable ISO images for BMR, built from a recovery token. Currently linux/amd64/iso only.

Method	Path	Description
GET	/backup/bmr/boot-media	List boot media artifacts (filter: tokenId, snapshotId, status)
POST	/backup/bmr/boot-media	Request boot media for a token (tokenId, optional bundleArtifactId)
GET	/backup/bmr/boot-media/:id	Get boot media artifact details and status
GET	/backup/bmr/boot-media/:id/download	Download the boot media ISO
GET	/backup/bmr/boot-media/:id/signature	Download the boot media’s detached signature

---

Verification & Recovery

Method	Path	Description
POST	/backup/verify	Run verification (deviceId, verificationType: integrity/test_restore)
GET	/backup/verifications	List verification results (filter: deviceId, verificationType, status, from, to)
GET	/backup/health	Organization backup health summary (query: refresh)
GET	/backup/recovery-readiness	Per-device readiness scores (query: deviceId, refresh)

---

Encryption Keys

Method	Path	Description
GET	/backup/encryption/keys	List encryption keys
POST	/backup/encryption/keys	Create encryption key
GET	/backup/encryption/keys/:id	Get key metadata
POST	/backup/encryption/keys/:id/rotate	Rotate key
DELETE	/backup/encryption/keys/:id	Deactivate a key (soft delete; blocked if a snapshot still references it)

---

Local Vaults

Method	Path	Description
GET	/backup/vault	List vaults
POST	/backup/vault	Create vault
PATCH	/backup/vault/:id	Update vault
DELETE	/backup/vault/:id	Delete a vault (soft delete)
POST	/backup/vault/:id/sync	Trigger sync
GET	/backup/vault/:id/status	Get vault sync status (last sync time, status, size, error)

---

SLA Management

Method	Path	Description
POST	/backup/sla/configs	Create SLA configuration
GET	/backup/sla/configs	List SLA configurations
PATCH	/backup/sla/configs/:id	Update an SLA configuration
DELETE	/backup/sla/configs/:id	Delete an SLA configuration and its events
GET	/backup/sla/events	Query SLA events and breaches
GET	/backup/sla/dashboard	Compliance dashboard: active configs, breach counts, average RPO/RTO

---

Cloud-to-Cloud (C2C)

Caution

Sync and restore execution are not yet implemented. POST /c2c/configs/:id/run creates a job that immediately fails with c2c_sync_not_implemented, and restore jobs fail the same way with c2c_restore_not_implemented. Connection and config setup below work today.

Method	Path	Description
GET	/c2c/m365/config	Check if platform M365 app is configured
GET	/c2c/m365/consent-url	Generate Microsoft admin consent URL
GET	/c2c/m365/callback	OAuth callback (public, CSRF-protected)
GET	/c2c/connections	List C2C connections
POST	/c2c/connections	Create connection (manual mode)
GET	/c2c/connections/:id	Get connection details
DELETE	/c2c/connections/:id	Revoke a connection
POST	/c2c/connections/:id/test	Test a connection; for a platform-app connection this also refreshes (re-authorizes) its access token
GET	/c2c/configs	List C2C backup configs
POST	/c2c/configs	Create/update backup scope and schedule
POST	/c2c/configs/:id/run	Trigger a sync (fails immediately — not yet implemented)
GET	/c2c/items	Search/browse backed-up items (filter: configId, userEmail, itemType, search)
GET	/c2c/dashboard	Connection, item, and storage summary stats
POST	/c2c/restore	Restore items by id (fails immediately — not yet implemented, see caution above)
GET	/c2c/restore/:id	Get a restore job’s status

---

Disaster Recovery

Method	Path	Description
POST	/dr/plans	Create DR plan
GET	/dr/plans	List plans
GET	/dr/plans/:id	Get plan details
POST	/dr/plans/:id/groups	Add recovery group
POST	/dr/plans/:id/execute	Execute plan (executionType: rehearsal/failover/failback)
GET	/dr/executions	List executions (query: planId)
GET	/dr/executions/:id	Get execution details
POST	/dr/executions/:id/abort	Abort running execution