同期ポリシーを更新

ソースの同期スケジュールを設定し、設定したスケジュールを返します。以前のスケジュールは置き換えられます。

保存しても同期は開始されません。最初のスケジュール同期は、更新から設定した間隔が経過した時点で実行予定になります。以降の同期は、前回の同期がキューに入ってから同じ間隔が経過した時点で実行予定になります。すぐに同期するには、ソースを同期 を呼び出してください。

このソースへのインポートが完了するたびに、ソースの新しい version でスケジュールを保存し直してください。インポートすると version が変わり、古い値に紐づいたままのスケジュールは、次の予定時刻に自動でオフになります。

スケジュールを変えずにスケジュール同期を一時停止するには、ソースを更新 でソースの status を disabled に設定します。停止中に実行予定になった同期は、ソースを active に戻した時点で実行されます。

読み取ってから保存する流れについては、ソースの同期とスケジュール設定 を参照してください。

PUT /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy

cURL

custom

curl --request PUT \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customIntervalSeconds": 21600,
  "enabled": true,
  "expectedRevision": 5,
  "expectedSourceVersion": 8,
  "mode": "custom"
}
'

200

success

{
  "created_at": "2026-09-01T08:05:00Z",
  "custom_interval_seconds": 21600,
  "enabled": true,
  "expected_source_version": 8,
  "id": "8e7d6c5b-4a39-4f28-9e17-0d1c2b3a4f5e",
  "knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
  "mode": "custom",
  "next_run_at": "2026-10-21T08:30:00Z",
  "revision": 6,
  "source_id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
  "updated_at": "2026-10-21T02:30:00Z"
}

Authorizations

Authorization · string · header · required

すべてのリクエストは、Authorization: Bearer {API_KEY} ヘッダーに指定した API キーで認証します。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーがない、または無効な場合は HTTP 401（unauthorized）が返ります。

Path Parameters

knowledge_base_id · string<uuid> · required

ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント（…/knowledge-fs/spaces/<knowledge base ID>）です。アドレスバーでは /datasets/new/ の後のセグメントです。

source_id · string<uuid> · required

ソース ID です。ソース一覧を取得 から取得します。

Body

application/json

enabled · boolean · required

スケジュール同期を実行するかどうかです。mode: manual では false にする必要があります。

expectedRevision · integer · required

同期ポリシーを取得 で取得した、スケジュールの現在の revision です。ソースにまだスケジュールがない場合は 0 を送信します。リビジョンはスケジュール同期が開始されるたびにも増えるため、更新の直前に読み取ってください。古い値を送ると 409 が返り、何も変更されません。

Required range: x >= 0

expectedSourceVersion · integer · required

ソースを取得 または ソース一覧を取得 で取得した、ソースの現在の version です。この値は ソースを更新 を呼び出すたび、またインポートが完了するたびに変わるため、更新の直前に読み取ってください。古い値を送ると 409 が返り、何も変更されません。

Required range: x >= 1

mode · enum<string> · required

manual はスケジュール同期をオフにし、interval は 24 時間ごと、custom は customIntervalSeconds ごとに同期します。

Available options: manual, interval, custom

customIntervalSeconds · integer

スケジュール同期の間隔（秒）です。1 時間から 30 日までの範囲で指定します。mode: custom では必須で、ほかのモードでは拒否されます。

Required range: 3600 <= x <= 2592000

Response

200

application/json

保存されたスケジュールです。mode: manual または enabled: false の場合、next_run_at は null です。

created_at · string

作成日時（ISO 8601）です。

custom_interval_seconds · integer | null

mode: custom の場合の間隔（秒）です。ほかのモードでは null です。

enabled · boolean

スケジュール同期を実行するかどうかです。mode: manual では常に false です。

expected_source_version · integer

スケジュールが紐付いているソースの version です。

id · string

同期ポリシー ID です。更新しても変わりません。

knowledge_space_id · string

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

mode · string

manual（スケジュールなし）、interval（24 時間ごと）、custom（custom_interval_seconds ごと）のいずれかです。

next_run_at · string | null

次回のスケジュール同期の予定日時（ISO 8601）です。予定がない場合は null です。

revision · integer

スケジュールのリビジョンです。同期ポリシーを更新 で expectedRevision として送信します。更新のたび、およびスケジュール同期が開始されるたびに増加します。

source_id · string

スケジュールが属するソースです。

updated_at · string

最終更新日時（ISO 8601）です。スケジュール同期が開始されたときにも更新されます。