From 1954da5a530407a9da415104b6215ce8e4180a64 Mon Sep 17 00:00:00 2001 From: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com> Date: Tue, 6 Jan 2026 07:30:27 -0600 Subject: [PATCH] docs tweaks --- docs/docs/configuration/record.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/docs/configuration/record.md b/docs/docs/configuration/record.md index f25eac863..032385e51 100644 --- a/docs/docs/configuration/record.md +++ b/docs/docs/configuration/record.md @@ -158,9 +158,9 @@ Apple devices running the Safari browser may fail to playback h.265 recordings. Media files (event snapshots, event thumbnails, review thumbnails, previews, exports, and recordings) can become orphaned when database entries are deleted but the corresponding files remain on disk. -This feature checks the file system for media files and removes any that are not referenced in the database. +Normal operation may leave small numbers of orphaned files until Frigate's scheduled cleanup, but crashes, configuration changes, or upgrades may cause more orphaned files that Frigate does not clean up. This feature checks the file system for media files and removes any that are not referenced in the database. -The API endpoint `POST /api/media/sync` can be used to trigger a media sync. The endpoint accepts a JSON request body to control the operation. +The Maintenance pane in the Frigate UI or an API endpoint `POST /api/media/sync` can be used to trigger a media sync. The endpoint accepts a JSON request body to control the operation. Request body schema (JSON): @@ -182,6 +182,8 @@ Request body schema (JSON): - `recordings` - `force` (boolean): If `true` the safety threshold is bypassed and deletions proceed even if the operation would remove a large proportion of files. Use with extreme caution. +When using the API, a job ID is returned and the operation continues on the server. Status can be checked with the `/api/media/sync/status/{job_id}` endpoint. + :::warning This operation uses considerable CPU resources and includes a safety threshold that aborts if more than 50% of files would be deleted. Only run when necessary. If you set `force: true` the safety threshold will be bypassed; do not use `force` unless you are certain the deletions are intended.