Files
dashback/docs/api/routes/backup/_id/vfs.md
2026-10-14 03:07:21 +02:00

1.3 KiB

GET /backup/{id}/vfs

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

List VFS files in a backup

Lists all virtual filesystem (VFS) files stored for the authorized company inside a specific backup archive.

Path parameters

Param Required Type Description
id yes string Backup identifier (e.g. backup-2026-10-14_02-00-00, backup-2026-10-14, backup-2026-10)

Query parameters

Param Required Type Description
companyId no integer Optional company ID to inspect (defaults to user's selected company)

Response 200

List of VFS files in the backup for the authorized company

{
  "backupId": "…",
  "companyId": 1,
  "files": [
    {
      "name": "…",
      "size": 1,
      "mime": "…",
      "mtime": "2026-08-10T00:00:00.000Z"
    }
  ]
}

Errors

Status Description
400 No company selected or invalid companyId — {"error":"…"}
403 Not authorized for the requested company — {"error":"…"}
404 Backup or VFS archive not found — {"error":"…"}
500 Internal server error — {"error":"…"}

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