SFTPGo Octri Preview
POST/user/streamzip

Download files and folders as a ZIP archive

Downloads multiple user files and folders as a ZIP archive streamed without being stored on the server. Send an array of absolute paths in the request body; only regular files and directories are included.

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

6 status codes
200Returns the ZIP archive as a binary stream.
400Returned when the request body is invalid.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Returned when the request is unauthenticated.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Returned when access to the requested files or folders is forbidden.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Returned when an internal server error occurs while generating the archive.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultReturned when an unexpected error occurs. The response includes an `error` description and a `message`, which can be empty.
errorstringoptional
error description if any
messagestringoptional
message, can be empty

Error handling

A 400 is returned when the request body is invalid, a 401 when authentication is missing or invalid, a 403 when access is forbidden, and a 500 when archive generation fails. Send a JSON array of absolute file or folder paths using application/json; only regular files and directories are included.