Sign in

v1

OpenAPI 3.1.0Proprietary2026-07-13197242444.9 KB
Sources

Execute Snapshot

Execute a snapshot for the specified source with configurable snapshot type.

This unified endpoint supports both incremental and blocking snapshots:

  • incremental (default): Uses watermarking to capture data in chunks while streaming continues. Supports additional_conditions for filtered snapshots. Requires primary keys.

  • blocking: Pauses streaming during the snapshot operation. Required for keyless tables. Faster for large tables but blocks streaming until complete. Note: additional_conditions filters are not supported for blocking snapshots.

For stopping/cancelling snapshots, use the cancel_snapshot endpoint which auto-detects the running snapshot type and uses the appropriate cancellation method.

post/sources/snapshot

Request body

source_idstring required
topic_namesstring[] nullable
snapshot_type'incremental' | 'blocking'

Type of snapshot to execute. 'incremental' uses watermarking and allows streaming to continue. 'blocking' pauses streaming and is required for keyless tables. Note: additional_conditions and surrogate_key are only supported for incremental snapshots.

surrogate_keystring nullable

Column name to use as surrogate primary key for all tables during snapshot chunking. Only supported for incremental snapshots, not blocking snapshots.

Response

Successful Response

{"stackTrail":"paths:/sources/snapshot:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}