Files
bookhoard/docs/developer/api/scanner/get_watch_mode_status.md
T
John O'Keefe 2c56ae4b9d docs(scanner): Beam batch 7 — all 10 scanner endpoints backfilled
Scanner surface frontmatter'd (scan/start/stop/cancel/status/active/
active-summary + watch start/stop/status) with provenance comments;
active-summary on a non-admin group.

Claude registry: 10 entries. Fixed handler drift Beam missed: scan_library
request has no "recursive"; scanner/start binds folder_paths (not
invented interval_seconds); scanner/stop binds no body; response is
{message, job_id, status} with 409 coalescing variant
{error, active_job_id}.

Gate fix in drift_test seed: registerScannerRoutes group seeds used bare
"jwt"/"admin" tokens invisible to authLabel; and silently passed before
only because the seeded set was unchecked. Seeds now 'jwtMiddleware'/
'AdminMiddleware' markers. Also: cleanup of a stale-merge-script residue
in collections/update_rule.md example (extra null keys). make test 9/9.
2026-10-24 17:20:46 -04:00

1.6 KiB

method, path, auth, area
method path auth area
GET /api/scanner/watch/status jwt+admin scanner

Get Watch Mode Status

Get the watch mode status for a library.

Endpoint: GET /api/scanner/watch/status Auth: Required (Admin only)

Query Parameters

Parameter Type Required Description
library_id string (UUID) Yes Library UUID to check

Request Headers

Header Type Required Description
Authorization string Yes Bearer token (must have admin role)

Example Request

GET /api/scanner/watch/status?library_id=550e8400-e29b-41d4-a716-446655440000
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Response (200 OK)

{
  "total_watching": null,
  "watching_libraries": null
}

Status Values

Status Description
watching Watch mode is active
stopped Watch mode is not active
error Watch mode encountered an error

Error Responses

Code Description
400 Missing library_id parameter
401 Invalid or expired token
403 User does not have admin privileges
404 Library not found