Skip to main content
POST
Bulk Execute Snapshot Sources

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 with configurable snapshot type.

ids
string[] | null

List of entity IDs to perform the action on. Omit if using select_all=true.

select_all
boolean
default:false

If true, select all entities matching the filters

filters
BulkSelectionFilter · object | null

Optional filters when select_all=true

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