Skip to main content
POST
Set a source's diff policy
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

POST /api/v2/knowledge/synchronized-sources/setDiffPolicy requires knowledge:manage. The body is {sourceId, expectedRevision, policy}: policy is null (changes apply without review), {"mode": "always"}, or {"mode": "conditional"} with at least one of deleteCountExceeds, protectedKinds (kinds the source declares) and protectCases: true. expectedRevision is the state’s policyRevision. The answer is {sourceId, outcome, revision}: updated (the source’s open diff runs stop, and later runs follow the new policy), unchanged, or stale (the policy moved; revision is its current one). A malformed policy answers 400 bad_request; a source outside the writable namespaces, 404 resource_missing. Only a Personal key is admitted, acting as its owner: the owner must hold the permission where the source lives, and is recorded as the decider, with the key named in the audit. An External App or platform key answers 403 forbidden, recorded: a person reviews and decides a source’s held changes. Send an Idempotency-Key to retry safely. A completed 200 response remains stored for 24 hours and is replayed only while the caller still holds knowledge:read and the source is still in its writable namespaces. Lost access, a missing source or a stored non-200 response yields 409 idempotency_result_unavailable; the request never runs twice.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

1–255 printable ASCII characters. A repeat with the same key and request never runs the write again, a 5xx included. It returns the first response (Idempotency-Replayed: true) only when the route's current authorization policy permits disclosure; otherwise 409 idempotency_result_unavailable. Honoured for External App JWTs and platform and MCP keys; an External App's static companion key is not protected.

Required string length: 1 - 255

Path Parameters

synchronizedSourceId
string
required
Minimum string length: 1

Body

application/json

policy: null (changes apply without review), {mode: "always"} (every run's changes wait for review), or {mode: "conditional", …} with at least one of deleteCountExceeds, protectedKinds (kinds the source declares) and protectCases: true. expectedRevision is the state's policyRevision.

expectedRevision
integer
required
Required range: x >= 0
policy
object
required

Response

Set a source's diff policy

data
object
required

The policy change: updated (the source's open diff runs stop, and later runs follow the new policy), unchanged (the same policy; nothing is written), or stale (expectedRevision was not the policy's revision, which revision gives).

meta
object
required