Trigger Sync Configuration

curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/{sync_config_id}/trigger

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

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:

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/

POST

buckets

{bucket_id}

syncs

{sync_config_id}

trigger

Trigger Sync Configuration

curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/{sync_config_id}/trigger

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Headers

Authorization

string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

authorization

string

X-Namespace

string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

bucket_id

string

required

sync_config_id

string

required

Query Parameters

full_sync

boolean

default:false

Response

Successful Response

Resume Sync Configuration Force Unlock Sync Configuration