1. files
Api
  • v1
    • files
      • upload
        POST
      • remove
        DELETE
      • findOne
        GET
      • update
        PATCH
      • download
        GET
    • dirs
      • findOne
      • remove
      • update
      • download
      • create
      • listItems
    • auth
      • login
      • register
    • usage
      GET
  • Schemas
    • v1
      • common
        • ErrorResponse
      • files
        • File
        • UpdateFileRequest
      • dirs
        • CreateDirectoryRequest
        • Directory
        • DirectoryItem
        • UpdateDirectoryRequest
      • auth
        • RegisterUserRequest
        • LoginUserRequest
        • RegisterUserResponse
        • LoginUserResponse
      • usage
  1. files

upload

Developing
POST
/v1/files
This endpoint handles uploading a single file along with saving it's metadata like name or user id.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params multipart/form-data

Responses

🟢201Created
application/json
Body

🔴500InternalServerError
🟠400BadRequestError
🟠403ForbiddenError
🟠401UnauthorizedError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://localhost:8080/v1/files' \
--header 'Authorization: Bearer <token>' \
--form 'file=@""' \
--form 'directoryId="{{$string.uuid}}"' \
--form 'idempotencyKey="idempotency-key"' \
--form 'checksum=""'
Response Response Example
201 - Example 1
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "userId": "string",
    "directoryId": "string",
    "name": "string",
    "size": 0
}
Modified at 2026-04-08 22:41:26
Next
remove
Built with