Filebox

File Storage API

Filebox is an API created using FastAPI to upload files to local storage.

Endpoints

Files

Method	Path	Description	User authenticated
GET	/files/{path}	Get file information	*
GET	/files/{path}/download	Download a file	×
POST	/files/	Upload a file	*
POST	/files/batch	Upload a list of files	*
DELETE	/files/{path}	Delete a file	*

Folders

Method	Path	Description	User authenticated
GET	/folders/{path}	Get specified folder	×
GET	/folders/	Get all folders and subitems	×
POST	/folders/	Create new folder	×
DELETE	/folders/	Delete a folder	×

Users

Method	Path	Description	User authenticated
GET	/users/{user_id}	Get specified account data	super_user
GET	/users/me	Get current account data	×
GET	/users/	Get all users	super_user
PUT	/users/{user_id}	Update a user	*
DELETE	/users/{user_id}	Delete a user	×
POST	/users/	Register a new account

Auth

Method	Path	Description	User authenticated
POST	/token	Get an access token

Setting up

Run using containers:

git clone https://github.com/triciopo/filebox
cd filebox
docker compose up -d

Run locally:

pip install -r requirements.txt
uvicorn filebox.main:app --port 8000 --reload

License

MIT License