SFTPGo Octri Preview
POST/user/file-actions/copy

Copy a file or a directory

Copies the specified file or directory to the target path for the logged in user. If the target already exists, it will be overwritten

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

2 parameters
pathstringrequired
Path to the file/folder to copy. It must be URL encoded, for example the path "my dir/àdir" must be sent as "my%20dir%2F%C3%A0dir"
targetstringrequired
New name. It must be URL encoded, for example the path "my dir/àdir" must be sent as "my%20dir%2F%C3%A0dir"

8 status codes
200successful operation
errorstringoptional
error description if any
messagestringoptional
message, can be empty
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
404Not Found
errorstringoptional
error description if any
messagestringoptional
message, can be empty
413Request Entity Too Large, max allowed size exceeded
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 404 is returned: Not Found. A 413 is returned: Request Entity Too Large, max allowed size exceeded. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.