Storage API

Download files from the configured storage backend (local filesystem or S3-compatible). Requires read:archive permission.

Download a File

Download a stored file

GET

/v1/storage/download

Downloads a file from the configured storage backend (local filesystem or S3-compatible). The path is sanitized to prevent directory traversal attacks. Requires read:archive permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Parameters

Query Parameters

path*

The relative storage path of the file to download.

Type

string

Required

Example"open-archiver/emails/abc123.eml"

Responses

The file content as a binary stream. The Content-Disposition header is set to trigger a browser download.

Content-Type

application/octet-stream

GET

/v1/storage/download

Playground

Authorization

bearerAuth

Variables

Key

Value

path*

Samples

Powered by VitePress OpenAPI