Skip to main content
POST
Bulk Snapshot Topics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request model for bulk snapshot operations at the topic level.

Accepts topic DB IDs, groups them by their source connector, and triggers per-source snapshots with the selected topics only.

topic_ids
string[]
required

List of topic DB IDs (_id) to operate on.

Required array length: 1 - 500 elements
snapshot_type
enum<string>
default:incremental

Type of snapshot to execute. 'incremental' (default) uses watermarking while streaming continues. 'blocking' pauses streaming during snapshot — required for keyless tables.

Available options:
incremental,
blocking

Response

Successful Response

Response model for bulk operations.

results
BulkOperationResult · object[]
required

Detailed results for each entity

summary
BulkOperationSummary · object
required

Summary statistics