Appearance
Upload API
Upload files (PST, EML, MBOX) to temporary storage before creating a file-based ingestion source. The returned filePath should be passed as uploadedFilePath in the ingestion source providerConfig.
Upload a File
Upload a file
POST
/v1/upload
Uploads a file (PST, EML, MBOX, or other) to temporary storage for subsequent use in an ingestion source. Returns the storage path, which should be passed as uploadedFilePath when creating a file-based ingestion source. Requires create:ingestion 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)
Request Body
multipart/form-data
The file to upload.
Format
"binary"Responses
File uploaded successfully. Returns the storage path.
application/json
JSON "filePath": "open-archiver/tmp/uuid-filename.pst"
{
}