Skip to main content

Snapshots

List Snapshots

Get a list of available snapshot files in the snapshot directory.
Response:

Export Workspace Snapshot

Export a workspace to a compressed zip archive and download it.
Request Body: Response:
  • On success: Returns the zip file as a binary download
  • Response headers include:
    • Content-Disposition: attachment; filename=<workspace>_<timestamp>.zip
    • Content-Type: application/zip
    • X-Snapshot-Size: <size_in_bytes>
Error Response (404):

Import Workspace Snapshot

Import a workspace from an uploaded zip file or URL. Import from file upload:
Import from URL:
Import with force overwrite:
Import files only (skip database):
Form Parameters: *Either file or url is required. Response (200):
Error Response (400):
Error Response (500 - workspace exists):

Delete Snapshot

Delete a snapshot file by name.
Response:
Error Response (404):

Legacy Endpoint

The legacy snapshot download endpoint is still available for backward compatibility:

Data Source Values

When a workspace is imported, its data_source field is set to indicate how it was created:

Security Considerations

Warning: Only import snapshots from trusted sources! Imported workspace data may contain:
  • Database records that could conflict with existing data
  • File paths that reference external resources
  • Configuration that may not be compatible
The imported workspace database state may be unstable. Use the skip_db=true parameter if you only need the files without database import.