Skip to main content
PATCH
Update knowledge source sync controls
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/update requires knowledge:manage. The body names sourceId and at least one of name, syncIntervalMinutes (15–1440) or status (active or paused). The source must remain in the credential’s writable namespaces. A missing, unreadable, being-removed or readable-only source answers 404 resource_missing. Pausing closes an open sync run and schedules its seal; resuming makes the source due now. Unchanged values write and audit nothing. Curation, trust weight and identity and group mappings of a connected source can only be changed by a person in the Forge Console. A source’s provider, container and target never change after it is connected: remove it and connect another. Send an Idempotency-Key to retry safely. A completed 200 response remains stored for 24 hours and is replayed only while the source remains writable. Lost access, a missing source or a stored non-200 response yields 409 idempotency_result_unavailable; the update 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

The sync controls a machine may change: name, syncIntervalMinutes and status (active or paused). Give at least one. Any other field answers 400: curation, trust weight and identity or group mappings are changed only by a person in the Forge Console.

name
string
required
syncIntervalMinutes
number
status
enum<string>
Available options:
active,
paused

Response

Updated knowledge source

data
object
required

One knowledge source in a namespace the caller can read: what it connects to (by provider), where it writes, whether it is active, paused or failing, and when it last and next syncs. lastError is redacted. Its configuration, cursor, external container id, identity and group mappings, curation, trust weight and creator are never returned.

meta
object
required