Files
dashback/docs/api/routes/vfs/rename.md
2026-10-07 20:36:50 +02:00

1.3 KiB

POST /vfs/rename

Protected. Requires a valid session cookie (credentials: 'include').

Rename or move a virtual filesystem file or directory

Renames or moves a file or directory within the virtual filesystem for the authenticated user's selected company. Parent directories for the destination path are created automatically if needed.

Body (JSON)

Field Required Type Description
oldPath yes string Existing VFS file or directory path (e.g. draft.txt)
newPath yes string New destination VFS path (e.g. archive/final.txt)
{
  "oldPath": "…",
  "newPath": "…"
}

Signals

On success, emits SSE signal: vfs (see GET /events).

Response 200

File or directory successfully renamed

{
  "success": true,
  "oldPath": "…",
  "newPath": "…"
}

Errors

Status Description
400 Path is required, invalid characters, traversal, or no company selected — {"error":"…"}
401 Unauthorized — {"error":"…"}
403 Not authorized, or cannot rename read-only database paths — {"error":"…"}
404 Source file or directory not found — {"error":"…"}

Generated from @openapi JSDoc. Do not edit by hand — run npm run docs:api.