Skip to content

File Storage

The File Storage module allows you to upload, retrieve, download, and delete files via the Spider API. Uploaded files are retained for a configurable period (default 14 days) and have a maximum size of 30 MB. All file metadata is stored in the Spider’s database, and the physical files are written to disk according to your Spider configuration.

File Upload

Upload endpoints accept multipart/form-data and enforce:

  • Default retention: 14 days
  • Max file size: 30 MB
Purpose Method Endpoint Content-Type
Create a new request with files POST /v3/request multipart/form-data
Upload additional files to existing request POST /v3/request/{requestId}/files/upload multipart/form-data

Note: {requestId} must be a valid long returned by a POST /v3/request call.

File Details

You can retrieve metadata about all stored files or a specific file by its ID.

Purpose Method Endpoint Description
List all files GET /v3/file-storage Fetches a list of file details
Get file metadata GET /v3/file-storage/{id} Fetches file details of a specific file

File Download

Download the binary content of a stored file.

Purpose Method Endpoint Description
Download a file GET /v3/file-storage/{fileId}/download Streams the file content

File Deletion

Files are removed automatically once their retention period expires. You may also delete files manually:

Purpose Method Endpoint
Delete a file DELETE /v3/file-storage/{id}

After deletion, both the database record and the on‑disk file are removed.

Retention Policy

  • Default retention: 14 days from upload
  • Deleted files cannot be recovered once the retention period has passed or a manual delete is performed.

File Configuration

Files persisted by the Spider will be stored to a location on disk specified in the configuration section of the Spider.

Warning: Do not manually move or delete files in the directory, as this will desynchronize the database records.