Welcome to FileVault API
FileVault is a powerful, multi-tenant file storage microservice that provides secure file management with support for multiple storage backends (Local, S3, Azure, GCS, FTP, SFTP, Dropbox).
Key Features
- Multi-tenant isolation with server codes
- Multiple storage backend support
- Path-based file organization
- Bulk operations for efficiency
- Public file sharing with password protection
- Archive operations (ZIP compress/extract)
- Rate limiting and quota management
- Complete audit logging
Path Convention
1. Module-based:
{module}/{recordId}/{path}/{filename}
Example:
matters/12345/evidence/contract.pdf
2. Documents module:
documents/{path}/{filename}
Example:
documents/templates/form.pdf
Never include the server code in the path - it's in the URL!
🔑 Service Token
Enter your FileVault service token to test the API endpoints below. Token format: fv_{64 hex chars}
Upload File
Upload files to FileVault with multipart form data. Supports multiple storage backends.
Request Body (multipart/form-data)
| Parameter | Type | Required | Description |
|---|---|---|---|
file |
file | Required | File to upload |
path |
string | Required | Storage path (e.g., matters/12345/contract.pdf) |
metadata |
json | No | Custom metadata object |
🧪 Try It Now
Response
Download File
Download files from FileVault by path. File is streamed directly without buffering.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
path |
string | Required | File path to download |
🧪 Try It Now
Response
List Files
Retrieve a listing of files and directories in a specified path.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
directory |
string | No | Directory path (default: root) |
🧪 Try It Now
Response
Delete File
Remove a file from FileVault. File is soft-deleted and can be restored.
🧪 Try It Now
Request Body
Response
Copy File
Create a copy of a file at a different location.
🧪 Try It Now
Request Body
Response
Move File
Move a file to a different location (rename or relocate).
🧪 Try It Now
Request Body
Response
Rename File
Rename a file without changing its directory location.
🧪 Try It Now
Request Body
Response
Create Directory
Create a new directory in the file system.
🧪 Try It Now
Request Body
Response
Compress Files
Create a ZIP archive from multiple files.
🧪 Try It Now
Request Body
Response
Extract Archive
Extract files from a ZIP archive.
🧪 Try It Now
Request Body
Response
Bulk Copy
Copy multiple files to a target directory in a single request. 10x faster than individual copies.
🧪 Try It Now
Request Body
Response
Bulk Move
Move multiple files to a target directory in a single request.
🧪 Try It Now
Request Body
Response
Bulk Delete
Delete multiple files in a single request.