Bucket Syncs
Trigger Sync Configuration
Changed onManually trigger a sync execution.
Creates a sync job and immediately dispatches it for async execution. The sync job processes files from the storage provider and creates objects in the bucket.
Execution Flow:
- Acquires distributed lock (prevents concurrent runs)
- Iterates files from storage provider with configured filters
- Creates objects idempotently (skips duplicates)
- Failed objects go to Dead Letter Queue (3 retries)
- Creates batches for collection processing (100 objects/batch)
- 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
Request
- Base URL: https://api.mixpeek.com
- URL: https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/{sync_config_id}/trigger
- Auth: HTTP bearer and API key in header X-Namespace
Path parameters
bucket_idstring required
sync_config_idstring required
Query parameters
full_syncboolean
Response
Successful Response
unknown required
Changes
- warning
removed the optional property
from the response with the status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- warning
- info
the endpoint scheme security
BearerAuth AND NamespaceHeaderwas added to the API
- info