Files
bookhoard/docs/developer/api/scanner/stop_watch_mode.md
T
john-okeefe c4607cd9b5 docs(api): complete backend documentation with all missing endpoints
Complete API documentation audit covering all backend endpoints.

Auth Endpoints:
- Fixed endpoint paths from /api/users/me/* to /api/auth/*
- Added update_email.md and update_username.md

Device Management:
- Device shelf operations (add, get, remove, clear)
- Device CRUD operations (update, delete)
- Registration management (pending, approve, reject)

Books Operations:
- Bulk delete and bulk update with normalization
- Download endpoint with format-specific headers

Conflict Resolution:
- Complete conflict management (list, get, resolve, delete)
- Bulk operations (bulk resolve, bulk dismiss, dismiss all)

Sync Protocols:
- KOReader: progress, metadata, library, bookmarks
- Kobo: markup, bookmarks, analytics, initialization, server sync

Scanner:
- Enhanced docs with manga/comic support
- Added 148-line comprehensive overview
- All formats documented (ebooks, comics, manga)

WebSocket:
- Comprehensive real-time sync API
- Messages, topics, authentication, examples

Documentation:
- Updated api-reference.md with all 122+ endpoints
- Updated index.md with new categories

Total: 36 new files, 6 modified files, 100% coverage
2026-02-08 12:39:46 -05:00

891 B

Stop Watch Mode

Stop watch mode for a library.

Endpoint: POST /api/scanner/watch/stop Auth: Required (Admin only) Content-Type: application/json

Request Body

Field Type Required Description
library_id string (UUID) Yes Library UUID to stop watching

Example Request

{
  "library_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response (200 OK)

{
  "message": "Watch mode stopped successfully",
  "library_id": "uuid",
  "status": "stopped"
}

Error Responses

Code Description
400 Invalid request data
401 Invalid or expired token
403 User does not have admin privileges
404 Library not found
400 Watch mode not active for this library

Try It Out