SFTPGo Octri Preview
POST/user/files

Upload files to user storage

Uploads one or more files to the authenticated user's storage using multipart/form-data. Supply the files in the filenames array and use path to select a parent directory; omitting path targets the root directory. Files with names that already exist are overwritten.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 1 body field
pathstringoptional
URL-encoded parent directory for the uploaded files. Defaults to the root path when omitted or empty.
mkdir_parentsbooleanoptional
Whether to create parent directories that do not exist.

Multipart form data containing one or more files to upload.

filenamesarray<string>optional
Array of binary files to upload. Must contain at least one file, and file entries must be unique.

8 status codes
201Returns an object containing a message and, if applicable, an error description.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
400Returned when the request is invalid.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Returned when the request is unauthorized.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Returned when access to the upload location is forbidden.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
413Returned when the maximum allowed upload size is exceeded.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
429Returned when the request limit is exceeded; you can retry the request later.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Returned when an internal server error occurs.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty

Error handling

The path query parameter must be URL encoded when supplied, and the filenames array must contain at least one distinct file. A 400 is returned for a bad request, a 401 when the request is unauthorized, a 403 when access is forbidden, a 413 when the maximum allowed size is exceeded, a 429 when the request limit is exceeded, and a 500 for an internal server error.