SFTPGo Octri Preview
GET/shares/{id}

Download shared files and folders as a ZIP archive

Downloads a ZIP archive containing the files and directories in a share. The share must have read scope, and its associated user must have list and download permissions; only regular files and directories are included. Set compress to control compression, or omit it to use the default of true.

2 parameters
idstringrequired
The unique identifier of the share to download.
compressbooleanoptional
Whether to compress the shared files and folders into the archive. Defaults to true when omitted.
Default:true

7 status codes
200Returns the ZIP archive containing the regular files and directories in the share.
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 the share lacks read scope or its associated user lacks list or download permission.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
429Returned when too many requests have been made; 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

A 400 is returned when the request is invalid, and a 401 when authentication is missing or invalid. A 403 is returned when the share lacks read scope or its associated user lacks list or download permission. A 429 indicates too many requests; retry later, while a 500 indicates an internal server error. The id path parameter must identify the share.