Files
bookhoard/docs/developer/api/collections/update_rule.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.1 KiB

method, path, auth, area
method path auth area
PUT /api/collections/:id/rules/:ruleId jwt collections

Update Collection Rule

Despite the route name, this endpoint toggles a rule's enabled state only. It does not update the rule's field/operator/value — rules are replaced wholesale via Create Collection (auto_assign_rules) or added via the rules endpoint.

Example request

{
  "enabled": false
}

Example response

{
  "collection_id": "550e8400-e29b-41d4-a716-446655440000",
  "is_smart": true
}

Request fields

Field Type Required Notes
enabled boolean yes toggles the rule on/off

Errors

Status Body When
400 {"error": "invalid collection id"} / {"error": "rule id required"} / {"error": "invalid request"} malformed
404 {"error": "rule not found"} no such rule
500 {"error": "..."} unexpected server error