Bulk Snapshot Topics
Execute snapshot for selected topics, grouped by their source connector.
Accepts topic DB IDs, resolves them to their source connectors, and triggers per-source snapshots scoped to only the selected topics (via topic_names).
Only topics produced by source connectors can be snapshotted - topics from transforms, destinations, or manually created topics are skipped.
Supports both incremental (default) and blocking snapshot types:
- incremental: Uses watermarking to capture data while streaming continues.
- blocking: Pauses streaming during snapshot. Required for keyless tables.
Results are reported per source connector, since snapshots are source-level operations. Returns partial success results - continues processing even if individual snapshots fail.
/topics/bulk/snapshotAuthorizationBearer token · headerrequiredapplication/jsontopic_idsstring[]requiredList of topic DB IDs (_id) to operate on.
snapshot_typestringType of snapshot to execute. 'incremental' (default) uses watermarking while streaming continues. 'blocking' pauses streaming during snapshot - required for keyless tables.
incrementalblockingSuccessful Response
resultsBulkOperationResult[]requiredDetailed results for each entity
Show propertiesHide properties
BulkOperationResultidstringrequiredEntity ID
successbooleanrequiredWhether the operation succeeded
messagestring | anySuccess message or error details
Show propertiesHide properties
stringanydataobject | anyOptional data returned by the operation
Show propertiesHide properties
objectanysummaryBulkOperationSummaryrequiredSummary statistics for a bulk operation.
Show propertiesHide properties
totalintegerrequiredTotal number of entities processed
succeededintegerrequiredNumber of successful operations
failedintegerrequiredNumber of failed operations
Validation Error
detailValidationError[]Show propertiesHide properties
ValidationErrorlocstring | integer[]requiredShow propertiesHide properties
string | integerstringintegermsgstringrequiredtypestringrequiredinputanyctxobject