Skip to main content
GET
/
v1
/
buckets
/
{bucket_id}
/
syncs
List Sync Configurations
curl --request GET \
  --url https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <x-namespace>'
{
  "syncs": [
    {
      "sync_config_id": "<string>",
      "bucket_id": "<string>",
      "connection_id": "<string>",
      "internal_id": "<string>",
      "namespace_id": "<string>",
      "source_path": "<string>",
      "file_filters": {
        "include_patterns": [
          "<string>"
        ],
        "exclude_patterns": [
          "<string>"
        ],
        "min_size_bytes": 1,
        "max_size_bytes": 1,
        "modified_after": "2023-11-07T05:31:56Z",
        "modified_before": "2023-11-07T05:31:56Z",
        "mime_types": [
          "<string>"
        ]
      },
      "sync_mode": "continuous",
      "polling_interval_seconds": 300,
      "batch_size": 50,
      "create_object_on_confirm": true,
      "skip_duplicates": true,
      "status": "PENDING",
      "is_active": true,
      "total_files_discovered": 0,
      "total_files_synced": 0,
      "total_files_failed": 0,
      "total_bytes_synced": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_sync_at": "2023-11-07T05:31:56Z",
      "next_sync_at": "2023-11-07T05:31:56Z",
      "created_by_user_id": "<string>",
      "last_error": "<string>",
      "consecutive_failures": 0,
      "metadata": {}
    }
  ],
  "total_count": 123
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.

Headers

​
Authorization
string
required

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

Examples:

"Bearer sk_live_abc123def456"

"Bearer sk_test_xyz789"

​
X-Namespace
string
required

REQUIRED: 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'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
bucket_id
string
required

Response

Successful Response

Envelope for listing sync configurations.

​
syncs
SyncConfigurationModel · object[]
required
​
total_count
integer
required