Files
bookhoard/docs/developer/api/scanner/stop_scanner.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

42 lines
1.0 KiB
Markdown

---
method: POST
path: /api/scanner/stop
auth: jwt+admin
area: scanner
---
<!-- source: internal/handlers/scanner.go:168 Handler.StopScanner -->
# Stop Scanner
Stop the automated background scanner for a library.
**Endpoint**: `POST /api/scanner/stop`
**Auth**: Required (Admin only)
**Content-Type**: `application/json`
## Request Body
| Field | Type | Required | Description |
| ---------- | ------------- | -------- | ----------------------------- |
| library_id | string (UUID) | Yes | Library UUID to stop scanning |
### Example Request
## Response (200 OK)
```json example-response
{
"message": "Scanner stopped successfully"
}
```
## 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 | Scanner not running for this library |