---
title: "Trigger Sync Configuration"
method: POST
path: "/v1/buckets/{bucket_id}/syncs/{sync_config_id}/trigger"
tags: ["Bucket Syncs"]
---

# Trigger Sync Configuration

`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`

Manually 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:**
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}

## Path parameters

- `bucket_id` string, required
- `sync_config_id` string, required

## Query parameters

- `full_sync` boolean

## Response `200`

Successful Response

- unknown

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Too Many Requests
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

- **2026-10-09** `61a175e8eb9a`: 1 warning, 5 info
  - removed the optional property `detail` from the response with the `422` status
  - added the non-success response with the status `429`
  - added the non-success response with the status `503`
  - added the optional property `success` to the response with the `422` status
  - …2 more
- **2026-08-09** `5d4c905106b4`: 1 info
  - the endpoint scheme security `BearerAuth AND NamespaceHeader` was added to the API

[Operation history](https://skmtc.dev/mixpeek/apis/mixpeek-api/changes/v1/buckets/:bucket_id/syncs/:sync_config_id/trigger/post.md)

---

[API](https://skmtc.dev/mixpeek/apis/mixpeek-api.md) - [All operations](https://skmtc.dev/mixpeek/apis/mixpeek-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mixpeek/apis/mixpeek-api/revisions/790bc16455f6?raw)