v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Bucket Syncs

Trigger Sync Configuration

Manually trigger a sync execution.

Creates a sync job and immediately dispatches it for async execution via Celery. The sync job processes files from the storage provider and creates objects in the bucket.

Execution Flow:

  1. Acquires distributed lock (prevents concurrent runs)
  2. Iterates files from storage provider with configured filters
  3. Creates objects idempotently (skips duplicates)
  4. Failed objects go to Dead Letter Queue (3 retries)
  5. Creates batches for collection processing (100 objects/batch)
  6. Emits metrics and releases lock

Use Cases:

  • Test sync configuration after creation
  • Force sync outside of scheduled intervals
  • Re-sync after updating connection credentials
  • Trigger incremental sync (only modified files)

Returns: sync_job_id to track progress via GET /syncs/{id}

post/v1/buckets/{bucket_id}/syncs/{sync_config_id}/trigger

Path parameters

bucket_idstring required
sync_config_idstring required

Query parameters

full_syncboolean

Response

Successful Response

{"stackTrail":"paths:/v1/buckets/{bucket_id}/syncs/{sync_config_id}/trigger:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}