Skip to main content
PATCH

Path Parameters

string
required
The name of the bucket containing the file.
string
required
The current full path to the file.

Headers

string
required
Must be set to application/json.

Query Parameters

boolean
default:"false"
If true, overwrite destination if it exists.

Body

You must provide either newName or newKey in the JSON body.
string
New filename (keeps the same folder).
string
Full destination path (can move across folders).

Response

boolean
Indicates whether the operation was successful.
string
A descriptive message of the operation result.
string
The new full destination path of the file.