Protection

Update mode settings

PATCH applies RFC 7396 JSON Merge Patch to the mode block (the protection master switch (off / observe / nudge / enforce)). null deletes a key; missing keeps; present replaces. Arrays are replaced wholesale (not item-merged). Requires Idempotency-Key and If-Match.

patch/protection/agent/{agent_id}/mode

Request

  • Base URL: https://api.mnemom.ai/v1
  • URL: https://api.mnemom.ai/v1/protection/agent/{agent_id}/mode
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Mnemom-Api-Key
    • API key in cookie mnemom_session

Path parameters

agent_idstring required

Agent identifier (e.g. smolt-abc123)

Headers

Idempotency-Keystring required

Client-supplied idempotency token. Replays within 24 hours return the stored result verbatim. See ADR-023.

If-Matchstring required

Optimistic concurrency token. Pass the ETag from a recent GET ("sha256:<hex64>" shape). A stale ETag returns 412 Precondition Failed; a missing header returns 428 Precondition Required. See RFC 9110 §13.1.1.

Request body

'off' | 'observe' | 'nudge' | 'enforce' required

Response

The mode primitive was updated at the agent scope.

oktrue required
scope'agent' required
scope_idstring required
resource'protection' required
primitive'mode' required
verb'put' | 'patch' required
value'off' | 'observe' | 'nudge' | 'enforce' required
content_hashstring required

New sha256:<hex64> of the spec at this scope after the write.

versioninteger
field_provenanceobject
_warningsobject

Pre-existing structural issues outside the modified primitive. Present only when the existing spec carries unrelated validation problems; never blocks the write.

Changes

No recorded changes to this operation across all 1 revision of this API.