SFTPGo Octri Preview
PATCH/user/filesDeprecated

Rename a file

Rename a file for the logged in user. Deprecated, use "file-actions/move"

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

2 parameters
pathstringrequired
Path to the file to rename. It must be URL encoded
targetstringrequired
New name. It must be URL encoded

6 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
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 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.