Skip to main content

​
Endpoint

PATCH /storage/{path}
Auth: API Key required

​
Path parameters

​
path
string
required
Path to the file or folder relative to the storage root. Use the id from List Storage.photo.jpg · photos/portrait.jpg · photos

​
Body parameters

​
name
string
required
The new name (not a full path). Must not contain / or \.

​
Response

{
  "success": true,
  "path": "photos/new-name.jpg"
}
​
success
boolean
true if the rename succeeded.
​
path
string
The new full path of the file or folder.
Status codes: 200 success · 400 invalid name · 404 not found · 409 a file or folder with that name already exists · 500 error

​
Example

curl -X PATCH http://localhost:3000/storage/photos/portrait.jpg \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{"name": "headshot.jpg"}'

Move File or Folder

Move a file or folder to a different parent folder.

List Storage

Browse all files and folders.