Sign in
v1
ApiIntegration

Configure sync

Configure a data sync from a source integration to DuckLake/DuckDB.

Parameters:

  • dest_integration_id: UUID of the destination (use GET /api/integrations?type=ducklake to find)
  • dest_schema: Schema name in the destination (e.g., 'POSTGRES_DATA')
  • schedule: How often to sync (hourly, every_4_hours, every_6_hours, every_12_hours, daily, weekly)
  • tables: For database sources, specify tables to sync:
    • Use schema.table for specific tables (e.g., public.users)
    • Use schema.* to sync all tables in a schema (e.g., public.*)
  • load_method: How to load data (merge, append, overwrite). Default: merge

Notes:

  • For database sources (postgres, mysql, etc.), the tables parameter is required
  • For extractor sources (stripe, hubspot, etc.), tables is optional (all data is synced)
  • The sync will start automatically based on the schedule after configuration
post/v1/api/integrations/{integration_id}/sync

Path parameters

string uuid required
OR
string required

Request body

dest_schemastring required

Destination schema name (e.g., 'POSTGRES_DATA')

schedule'hourly' | 'every_4_hours' | 'every_6_hours' | 'every_12_hours' | 'daily' | 'weekly' required

Available sync schedules.

tablesstring[] nullable

Tables to sync. For databases: use 'schema.table' for specific tables or 'schema.*' for all tables in a schema. Required for database sources.

load_method'merge' | 'append' | 'overwrite'

Available load methods for syncing data.

Response

Sync configured successfully

sync_configobject required
dag_generatedboolean required
messagestring

Changes

No recorded changes to this endpoint across all 1 revision of this API.