API ReferenceSource Connections

Run

Trigger a sync run for a source connection. Runs are always executed through Temporal workflow engine. Args: db: Database session source_connection_id: ID of the source connection to run ctx: API context with organization and user information guard_rail: Guard rail service for usage limits force_full_sync: If True, forces a full sync with orphaned entity cleanup for continuous syncs. Raises 400 error if used on non-continuous syncs (which are always full syncs).

Authentication

x-api-keystring
API Key authentication via header

Path Parameters

source_connection_idstringRequiredformat: "uuid"

Headers

X-Framework-NamestringOptional
X-Framework-VersionstringOptional

Query Parameters

force_full_syncbooleanOptionalDefaults to false
Force a full sync ignoring cursor data instead of waiting for the daily cleanup schedule. Only allowed for continuous syncs.

Response

Successful Response
idstringformat: "uuid"
source_connection_idstringformat: "uuid"
statusenum
Sync job status enum.
started_atstring or nullformat: "date-time"
completed_atstring or nullformat: "date-time"
duration_secondsdouble or null
entities_insertedinteger or nullDefaults to 0
entities_updatedinteger or nullDefaults to 0
entities_deletedinteger or nullDefaults to 0
entities_failedinteger or nullDefaults to 0
errorstring or null
error_detailsmap from strings to any or null

Errors