Sync

Operations of the Connector Sync API. Paths are relative to your deployment's API host.

GET /api/connector-sync-api/sync

List sync configs for a project

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/connector-sync-api/sync

Create a sync config for a project + adapter (not authorised until a person authorises it)

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json CreateSyncConfigDto

GET /api/connector-sync-api/sync/{adapterKey}

Get the sync config for one adapter

Authentication: bearer token (Authorization: Bearer <token>)

PATCH /api/connector-sync-api/sync/{adapterKey}

Update a sync config (a direction change needs re-authorising)

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json UpdateSyncConfigDto

DELETE /api/connector-sync-api/sync/{adapterKey}

Remove a sync config, revoking its authority first

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/connector-sync-api/sync/{adapterKey}/authorise

Authorise the schedule: lend it a durable delegation of the owner's authority over the connection and project

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json AuthoriseSyncScheduleDto

POST /api/connector-sync-api/sync/{adapterKey}/revoke

Revoke the schedule's authority; it does not fire until re-authorised

Authentication: bearer token (Authorization: Bearer <token>)

GET /api/connector-sync-api/sync/{projectId}/analyses

List analyses for a project

Authentication: bearer token (Authorization: Bearer <token>)

GET /api/connector-sync-api/sync/{projectId}/analysis/{analysisId}

Get the status and results of a content scan

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/connector-sync-api/sync/{projectId}/analysis/{analysisId}/confirm

Confirm a mapping proposal and create the sync mappings

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json ConfirmMappingsDto

POST /api/connector-sync-api/sync/{projectId}/analysis/{analysisId}/generate-mapping

Generate an AI mapping proposal for a completed analysis

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json GenerateMappingDto

GET /api/connector-sync-api/sync/{projectId}/analysis/{analysisId}/tree

Scan the analysed provider's content structure live; the tree is never stored

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/connector-sync-api/sync/{projectId}/analyze

Start a documentation structure scan, under a per-run delegation the caller authorises

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json TriggerAnalysisDto

POST /api/connector-sync-api/sync/{projectId}/execute

Run a sync now, under a per-run delegation the caller authorises

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json ExecuteSyncDto

GET /api/connector-sync-api/sync/{projectId}/status

A project's sync status: each config's authority and latest run

Authentication: bearer token (Authorization: Bearer <token>)