v1

OpenAPI 3.1.0Proprietary2026-07-13197242444.9 KB
Topics

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.

post/topics/bulk/snapshot

Request body

topic_idsstring[] required

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

snapshot_type'incremental' | 'blocking'

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

Response

Successful Response