RUruncaptain
sync

Create Backblaze Sync

Changed on

Create a Backblaze B2 Sync for a collection and start the initial backfill. Returns the sync; indexing runs asynchronously.

post/v2/collections/{collection_name}/sync/backblaze

Request

  • Base URL
    https://api.captain.dev
  • URL
    https://api.captain.dev/v2/collections/{collection_name}/sync/backblaze
  • Auth
    none declared

Path parameters

collection_namestring required

Destination collection.

Headers

authorizationstring nullable

Bearer {api_key}. Your Captain API key.

Request body

bucketstring required

Backblaze B2 bucket to keep in sync with the collection.

prefixstring

Key prefix to scope the sync. Empty syncs the whole bucket.

endpoint_urlstring required

Backblaze B2 S3 endpoint, e.g. https://s3.REGION.backblazeb2.com

regionstring

Region of the bucket (e.g. 'us-west-004'), matching the endpoint.

access_key_idstring required

Backblaze B2 Application Key ID (S3 access key ID).

secret_access_keystring required

Backblaze B2 Application Key (S3 secret). Stored securely, never returned.

processing_type'advanced' | 'basic' required

Parsing tier.

include_patternsstring[]

Glob patterns; only matching keys are synced.

exclude_patternsstring[]

Glob patterns; matching keys are excluded.

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

How to propagate objects removed from the source: mirror removes them from the collection so they no longer appear in search; archive keeps the document's content but marks it archived, excluded from search by default and surfaced with include_archived: true; ignore leaves the indexed copy in place.

custom_metadataobject

Static metadata applied to every synced document.

sync_interval_minutesinteger nullable

Scheduled reconcile cadence (minimum 5; null = manual).

Response

Successful Response

sync_idstring
collection_namestring
bucketstring
prefixstring
regionstring
storage_type's3' | 'gcs' | 'r2' | 'supabase' | 'backblaze' | 'azure'

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' | 'account_key'

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 nullable

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

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

  • d07ce3783494Revision changes
    • info

      api operation id create-backblaze-sync removed and replaced with sync_createBackblazeSync

  • 8a4e045bc3faRevision changes
    • warning

      added the new account_key enum value to the response property for the response status

    • warning

      added the new azure enum value to the response property for the response status

    • info

      added the optional property to the response with the status