SFTPGo Octri Preview
GET/shares/{id}/files

Download a single file from share

Returns the file contents as response body. The share must have exactly one path defined and it must point to a directory. Use the path query parameter to specify which file within the shared directory to download

2 parameters
idstringrequired
the share id
pathstringrequired
Path to the file to download. It must be URL encoded, for example the path "my dir/àdir/file.txt" must be sent as "my%20dir%2F%C3%A0dir%2Ffile.txt"

8 status codes
200successful operation
206successful operation
400Bad Request
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Unauthorized
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Forbidden
errorstringoptional
error description if any
messagestringoptional
message, can be empty
429Too Many Requests. The client can retry the request later
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Internal Server Error
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: Bad Request. A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 429 is returned: Too Many Requests. The client can retry the request later. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.