Backups

Endee supports creating and restoring index backups. Backups are stored per-user and can be used to migrate indexes, recover from data loss, or snapshot a known-good state.

API Endpoints

Method	Endpoint	Description
POST	`/api/v1/index/{name}/backup`	Create async backup
GET	`/api/v1/backups`	List all backups
GET	`/api/v1/backups/active`	Check active backup for current user
GET	`/api/v1/backups/{name}/info`	Get backup metadata
POST	`/api/v1/backups/{name}/restore`	Restore backup to a new index
DELETE	`/api/v1/backups/{name}`	Delete a backup

Create a Backup

Backups are created asynchronously. The API returns immediately with 202 and a backup_name — the backup runs in a background thread.


POST /api/v1/index/{name}/backup

While a backup is in progress, write operations are paused — only read/search operations remain active. Once the backup completes, writes resume automatically.

Only one active backup per user is allowed at a time.

Restore a Backup

Restoring extracts the backup and registers the index under a new name.


POST /api/v1/backups/{name}/restore

Requirements:

The backup must exist
The target index name must not already exist

Restore always creates a new index. It will not overwrite an existing index.

Get Backup Info

Returns metadata for a specific backup:


GET /api/v1/backups/{name}/info

Response includes: original_index, timestamp, size_mb, and index parameters.

List and Delete Backups


GET    /api/v1/backups           # list all backups for current user
DELETE /api/v1/backups/{name}    # delete a specific backup

If the server crashes or restarts during a backup, the backup will not complete automatically. You will need to start a new backup once the server re-starts.