API Reference

80+ REST endpoints. Full programmatic control.

Authentication

All /api/v1/ endpoints (except /health) require a Bearer token in the Authorization header.

Authorization: Bearer <token>

Rate Limiting

600 requests per minute per IP.

Endpoints

Authentication

MethodPathDescription
POST/api/v1/auth/loginLog in and receive a Bearer token
POST/api/v1/auth/logoutInvalidate the current token
GET/api/v1/auth/statusCheck authentication status

Backup Sources

MethodPathDescription
GET/api/v1/sourcesList all sources
POST/api/v1/sourcesCreate a new source
GET/api/v1/sources/{id}Get source details
PUT/api/v1/sources/{id}Update source configuration
DELETE/api/v1/sources/{id}Delete a source

Backup Operations

MethodPathDescription
POST/api/v1/backup/runTrigger a backup
GET/api/v1/backup/progressGet backup progress
GET/api/v1/backup/stateGet backup state
POST/api/v1/backup/cancelCancel a running backup

Snapshots

MethodPathDescription
GET/api/v1/snapshotsList snapshots
GET/api/v1/snapshots/{id}Get snapshot details
GET/api/v1/snapshots/changesGet snapshot change summary

File Browsing & History

MethodPathDescription
GET/api/v1/filesBrowse files in a snapshot
GET/api/v1/historyGet version history for a file
GET/api/v1/history/contentGet file content at a version
GET/api/v1/history/diffDiff two versions of a file
POST/api/v1/history/restoreRestore files from history

Repositories

MethodPathDescription
GET/api/v1/repositoriesList all repositories
POST/api/v1/repositoriesCreate a repository
GET/api/v1/repositories/{id}Get repository details
PUT/api/v1/repositories/{id}Update repository
DELETE/api/v1/repositories/{id}Delete a repository

Cloud Storage

MethodPathDescription
GET/api/v1/cloud/backendsList cloud backends
POST/api/v1/cloud/backendsCreate a cloud backend
POST/api/v1/cloud/testTest cloud backend connection

Retention & GC

MethodPathDescription
POST/api/v1/retention/applyApply retention policy
POST/api/v1/retention/gcRun garbage collection
POST/api/v1/retention/verifyVerify backup integrity

Monitoring

MethodPathDescription
GET/api/v1/oversight/healthSystem health check
GET/api/v1/oversight/alertsList active alerts
POST/api/v1/oversight/patrolRun system patrol

Encryption Keys

MethodPathDescription
POST/api/v1/keys/exportExport encryption keys
POST/api/v1/keys/importImport encryption keys