Bulk Execute Snapshot Sources

Execute snapshot on multiple sources in parallel.

Supports both incremental (default) and blocking snapshot types via the snapshot_type field:

• incremental: Uses watermarking to capture data while streaming continues.
• blocking: Pauses streaming during snapshot. Required for keyless tables. Executed with lower concurrency and staggered timing to avoid overwhelming Kafka Connect.

Supports two modes for source selection:

1. Explicit IDs: Pass a list of source IDs
2. Select all: Set select_all=true with optional filters

Returns partial success results - continues processing even if individual snapshots fail (e.g. 409 when a snapshot is already running for a source).

POST /sources/bulk/snapshot

Bulk Execute Snapshot Sources

cURL

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"
}
'

200

{
  "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

Show child attributes

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

200

application/json

Successful Response

Response model for bulk operations.

results · BulkOperationResult · object[] · required

Detailed results for each entity

Show child attributes

summary · BulkOperationSummary · object · required

Summary statistics

Show child attributes