Create Azure Sync | Captain Docs

Create an Azure Blob Storage Sync for a collection and start the initial backfill. Azure authenticates with the storage account’s name and account key (stored securely, never returned), so there is no region, endpoint_url, or assume-role; the container is echoed back as bucket. Returns the sync; indexing runs asynchronously.

Path parameters

collection_namestringRequired

Destination collection.

Request

This endpoint expects an object.

containerstringRequired

Azure Blob container to keep in sync with the collection (3-63 chars, lowercase letters, digits, single hyphens). Echoed as bucket in sync responses.

account_namestringRequired

Azure storage account name (the <account> in https://<account>.blob.core.windows.net; 3-24 lowercase letters and digits).

account_keystringRequired

Storage account access key (key1 or key2) with read access to the container. Stored securely, never returned. Rotate later with PATCH /v2/syncs/{sync_id}.

processing_typeenumRequired

Parsing tier. ‘advanced’ = full document understanding; ‘basic’ = faster/cheaper.

prefixstringOptionalDefaults to

Object-name prefix to scope the sync (e.g. ‘docs/2024/’). Empty syncs the whole bucket.

include_patternslist of stringsOptional

Glob patterns; only matching blob names are synced.

exclude_patternslist of stringsOptional

Glob patterns; matching blob names are excluded.

deletion_policyenumOptionalDefaults to mirror

How to propagate blobs removed from Azure: 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.

metadata_mappingmap from strings to strings or nullOptional

Maps an Azure blob metadata key to a Captain metadata field name.

custom_metadataobject or nullOptional

Static metadata applied to every synced document.

sync_interval_minutesinteger or nullOptionalDefaults to 60

Scheduled reconcile cadence in minutes (minimum 5; below 5 clamps to 5). Defaults to 60 for Azure so reconcile backstops any missed Event Grid delivery; null = manual (no scheduled reconcile).

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