Update Sync | Captain Docs

import requests
BASE_URL = "https://api.captain.dev"
API_KEY = "your_api_key"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}
response = requests.patch(
    f"{BASE_URL}/v2/syncs/sync_7e0abee6e110457db2c8",
    headers=headers,
    json={
        "prefix": "knowledge-base/2024/",
        "include_patterns": [
            "*.pdf",
            "*.docx"
        ],
        "exclude_patterns": [
            "drafts/*"
        ],
        "deletion_policy": "mirror",
        "status": "active",
        "custom_metadata": {
            "team": "research"
        },
        "sync_interval_minutes": 30
    }
)
print(response.json())

{
  "sync_id": "sync_7e0abee6e110457db2c8",
  "collection_name": "company-knowledge",
  "bucket": "my-company-docs",
  "prefix": "knowledge-base/2024/",
  "region": "us-east-1",
  "auth_method": "iam_role",
  "processing_type": "advanced",
  "include_patterns": [
    "*.pdf",
    "*.docx"
  ],
  "exclude_patterns": [
    "drafts/*"
  ],
  "deletion_policy": "mirror",
  "status": "active",
  "secret_set": false,
  "sns_subscribe_url": null,
  "last_backfill_job_id": "91f2aa031d8f4e7d8877c4564eb486bd-1786120498",
  "last_reconcile_at": null,
  "sync_interval_minutes": 30,
  "next_sync_at": 1786120589056,
  "sync_state": "idle",
  "last_sync_at": null,
  "last_sync_error": null,
  "created_at": "2026-08-07T16:34:58.188233+00:00",
  "updated_at": "2026-08-07T16:34:58.612676+00:00"
}

Update a sync’s prefix, glob filters, deletion policy, cadence, custom metadata, or status (pause/resume). Only provided fields change.

Path parameters

sync_idstringRequired

The sync id.

Request

This endpoint expects an object.

prefixstringOptional

New key prefix to scope the sync.

include_patternslist of stringsOptional

Replacement include glob patterns.

exclude_patternslist of stringsOptional

Replacement exclude glob patterns.

deletion_policyenumOptional

New deletion-propagation policy.

statusenumOptional

‘paused’ stops syncing without deleting the sync; ‘active’ resumes.

custom_metadatamap from strings to anyOptional

Replacement static metadata.

sync_interval_minutesinteger or nullOptional

New cadence in minutes. MINIMUM 5 (below 5 clamps to 5; >=5 honored exactly). null = manual. Read the sync back for the effective value.

account_keystring or nullOptional

Azure Blob syncs only: a new storage-account key (key1 or key2). Validated against the container before it replaces the stored key: the supported path for Azure key rotation. Rejected with 422 on non-Azure syncs. Never returned.

Response

Successful Response

sync_idstringOptional

collection_namestringOptional

bucketstringOptional

prefixstringOptional

regionstringOptional

storage_typeenumOptional

The sync’s cloud storage type. Returned by the list endpoint (GET /v2/syncs) only; other sync endpoints omit this field.

auth_methodenumOptional

How the sync authenticates to the bucket: ‘iam_role’ (AWS cross-account assume-role), ‘access_key’ (S3-compatible key pair), or ‘service_account’ (GCS service-account JSON).

account_namestring or nullOptional

Azure Blob syncs only: the storage account name. Null for other providers.

endpoint_urlstring or nullOptional

S3-compatible endpoint URL (access-key syncs on non-AWS providers); null for AWS S3. Returned by the list endpoint (GET /v2/syncs) only; other sync endpoints omit this field.

processing_typeenumOptional

include_patternslist of stringsOptional

exclude_patternslist of stringsOptional

deletion_policyenumOptional

statusenumOptional

secret_setbooleanOptional

True once an event-webhook secret has been minted.

sns_subscribe_urlstring or nullOptional

SNS subscribe URL; only surfaced by the subscribe-webhook endpoint.

last_backfill_job_idstring or nullOptional

last_reconcile_atstring or nullOptional

sync_interval_minutesinteger or nullOptional

Effective (already-clamped) cadence; null = manual.

next_sync_atinteger or nullOptional

Epoch ms of the next due scheduled reconcile.

sync_stateenum or nullOptional

last_sync_atinteger or nullOptional

last_sync_errorstring or nullOptional

created_atstringOptional

updated_atstring or nullOptional

Path parameters

Headers

Request

Response