Documentation

The API behind the workflow.

Authenticate a source, request an upload URL and work with backup metadata.

All guides
A technical field guide with an amber bookmark and file tiles

Ask AI about CalmBackup

See what it does, who it’s for, and whether it fits your needs.

Opens with product context and a link to this page.

View or copy the prompt

API reference

Most users never interact with the API directly — the CLI handles all API communication. All endpoints require an Authorization: Bearer YOUR_API_KEY header.

POST/api/v1/upload-url

Get presigned upload URL

POST/api/v1/backups/{id}/confirm

Confirm upload completed

GET/api/v1/backups

List backups

GET/api/v1/backups/{id}

Get backup + download URL

DELETE/api/v1/backups/{id}

Delete backup

GET/api/v1/account

Account info

The upload lifecycle

  1. Authenticate with the source API key and request a presigned upload URL for the encrypted file.
  2. Upload the encrypted archive to that URL.
  3. Confirm its size and SHA-256 checksum with the API.

Confirmation compares the submitted metadata with the backup record. It is not an application restore test or a server-side decryption of the archive.

What belongs in API metadata

Source identity, filename, byte size, checksum, driver and status support the backup workflow. The archive encryption key is used locally and is not part of the upload or confirmation request.

Read the privacy boundary →