STstreamkap
Sources

Cancel Snapshot

Changed on

Cancel an in-progress snapshot with automatic type detection.

This endpoint automatically detects the type of snapshot currently running and uses the appropriate cancellation method:

  • Incremental/Filtered snapshots: Streaming continues. Progress is preserved and can be resumed later.

  • Blocking snapshots: Streaming resumes after cancellation. Partial progress is lost - must re-trigger if needed.

Returns 404 if no snapshot is currently running for the specified source.

post/sources/cancel_snapshot

Request

Request body

source_idstring required
topic_namesstring[] nullable
surrogate_keystring nullable

Column name to use as surrogate primary key for all tables during snapshot chunking. Useful for tables without primary keys or when a more efficient column exists for chunking.

filter_regexstring nullable

Optional restrictive regex applied by the orchestrator to the physical tables the controller expands, across ALL triggered selectors. Matched (via search) against each physical's fully-qualified identifier <database-or-schema>.<table>, so it can narrow by DB/schema, table name, or a table-name suffix — the caller decides. Only matching physicals are snapshotted. Use to backfill a specific subset without re-snapshotting a regex source's full expansion. Null → no restriction.

Response

Successful Response

unknown required

Changes