Skip to main content
POST
/
sources
/
bulk
/
snapshot
Bulk Execute Snapshot Sources
curl --request POST \
  --url https://api.streamkap.com/sources/bulk/snapshot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "select_all": false,
  "filters": {
    "source_id": "<string>",
    "destination_id": "<string>"
  },
  "snapshot_type": "incremental"
}
'
{
  "results": [
    {
      "id": "<string>",
      "success": true,
      "message": "<string>",
      "data": {}
    }
  ],
  "summary": {
    "total": 123,
    "succeeded": 123,
    "failed": 123
  }
}

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

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