sync

Update S3 Sync

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

patch/v2/syncs/{sync_id}

Path parameters

sync_idstring required

The sync id.

Headers

authorizationstring nullable

Bearer {api_key}. Your Captain API key.

Request body

prefixstring

New key prefix to scope the sync.

include_patternsstring[]

Replacement include glob patterns.

exclude_patternsstring[]

Replacement exclude glob patterns.

deletion_policy'mirror' | 'archive' | 'ignore'

New deletion-propagation policy.

status'active' | 'paused'

'paused' stops syncing without deleting the sync; 'active' resumes.

custom_metadataobject

Replacement static metadata.

sync_interval_minutesinteger nullable

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

Response

Successful Response

sync_idstring

collection_namestring

bucketstring

prefixstring

regionstring

storage_type's3' | 'gcs' | 'r2' | 'supabase' | 'backblaze'

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

auth_method'iam_role' | 'access_key' | 'service_account'

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).

endpoint_urlstring nullable

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_type'advanced' | 'basic'

include_patternsstring[]

exclude_patternsstring[]

deletion_policy'mirror' | 'archive' | 'ignore'

status'active' | 'paused' | 'inactive'

secret_setboolean

True once an event-webhook secret has been minted.

sns_subscribe_urlstring nullable

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

last_backfill_job_idstring nullable

last_reconcile_atstring nullable

sync_interval_minutesinteger nullable

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

next_sync_atinteger nullable

Epoch ms of the next due scheduled reconcile.

sync_state'idle' | 'running' | 'error'

last_sync_atinteger nullable

last_sync_errorstring nullable

created_atstring

updated_atstring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.