user APIs

Rename a file

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

patch/user/files

Request

Base URL
/api/v2 (relative, and the document was published on a file host, not at the API’s origin)
Auth
- HTTP bearer
- or API key in header X-SFTPGO-API-KEY
TypeScript
https://skmtc.dev/kanton-bern/apis/sftpgo/docs/user/files/patch.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pathstring required

Path to the file to rename. It must be URL encoded

targetstring required

New name. It must be URL encoded

Response

successful operation

messagestring

message, can be empty

errorstring

error description if any

Changes

No recorded changes to this operation across all 1 revision of this API.