#
List of Routes
Query routes are unauthorized by default (changeable in config.yaml
), and state-changing routes (create, update, delete) require authorization.
#
Query routes
- /list: Lists the file in a given directory. Lists root directory if unspecified.
- /retrieve: Retrieves file specified. Supports video streaming.
- /filetree: Returns a JSON representation of any subdirectories. Only lists directories, files are omitted.
- /search: Searches for files/folders across the entire directory. (Only available if
indexing
config option is enabled) - /logs: Retrieves logs stored in the database. (Only available if both
database
andlogs
config option are enabled)
#
State-changing routes
- /upload: Uploads files into directory provided.
- /delete: Deletes files specified.
- /makedir: Creates a folder in directory specified.
- /move: Moves files and/or folders into a given directory.
- /copy: Copy files and/or folders into a given directory.
- /rename: Renames a file specified.
- /shortcut: Creates a
*.shortcut.json
file containing target path data in current path. Not a symlink. - /metadata: Changes metadata for directories specified. (Only available if
metadata
config option is enabled)
#
Authorization routes
- /authorize/get: Get JWT from body provided.
- /authorize/logout: Delete any token cookie in request.
#
Advanced Auth
- /authorize/login: Advanced version of /authorize/get that doesn't allow API key logins for security. Get and send JWT from user data.
- /authorize/register: Get JWT from user data and registers the user.
- /authorize/delete: Deletes user data from database, and removes token cookie from client.
- /authorize/user: Searches for users matching a query string, or index all if none provided.
- /authorize/{"username"}/modify: Modify user data of username provide.