Sign in

v1

OpenAPI 3.1.0Proprietary2026-07-13197242444.9 KB
Sources

Cancel Snapshot

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 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.

Response

Successful Response

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