For the complete documentation index, see llms.txt. This page is also available as Markdown.

Synchronization and scheduling

Pair configuration, sync runs, progress streams, and scheduler endpoints.

Use these endpoints to configure pairs, run synchronization, and manage schedules.

Pairs

Method
Endpoint
Purpose

GET

/api/sync/providers

List sync providers and capabilities.

GET

/api/pairs

List sync pairs.

POST

/api/pairs

Create a sync pair.

POST

/api/pairs/reorder

Reorder pairs.

PUT

/api/pairs/{pair_id}

Update a pair.

DELETE

/api/pairs/{pair_id}

Delete a pair.

GET

/api/sync/providers/counts

Return feature counts.

Start with removals disabled. Enable them after confirming the baseline.

Runs

Method
Endpoint
Purpose

POST

/api/run

Start a synchronization run.

GET

/api/run/summary

Return the latest run summary.

GET

/api/run/unresolved

Return unresolved items.

GET

/api/run/summary/file

Download the latest summary.

GET

/api/run/summary/stream

Stream progress using SSE.

Send pair_id in the request body to run one pair.

Scheduling

Method
Endpoint
Purpose

GET

/api/scheduling

Return schedule configuration.

POST

/api/scheduling

Save schedule configuration.

GET

/api/scheduling/status

Return scheduler status.

GET

/api/scheduling/next

Return upcoming scheduled work.

POST

/api/scheduling/replan_now

Recalculate the schedule.

POST

/api/scheduling/trigger_now

Trigger scheduled work now.

POST

/api/scheduling/stop

Stop the scheduler.

SSE clients must reconnect after interruption and ignore ping events.

Last updated

Was this helpful?