Skip to content
Streamkap
Esc
↑↓navigate↵open⌘Jpreview

Bulk Parallel Snapshot Sources

Execute Fast Parallel (parallel-chunk) snapshot on multiple sources.

Mirrors the per-source POST /sources/execute_parallel_snapshot semantics fanned out across all targeted sources: seeds user intent into Mongo.sources.snapshotting_tables; the in-process orchestrator picks up on its next cycle. No KC signal-table writes, no row/table locks.

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 even when individual sources fail (e.g. regex source with no table.include.list).

POST/sources/bulk/parallel-snapshot
Authorization
AuthorizationBearer token · headerrequired
Request body
requiredapplication/json
idsstring[] | null

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

Show properties
Any of:
string[]
Array of string
string
null
null
select_allboolean

If true, select all entities matching the filters

default: false
filtersBulkSelectionFilter | null

Optional filters when select_all=true

Show properties
Any of:
BulkSelectionFilter
source_idstring | null

Filter by source ID (for pipelines/destinations)

Show properties
Any of:
string
string
null
null
destination_idstring | null

Filter by destination ID (for pipelines/destinations)

Show properties
Any of:
string
string
null
null
null
null
Responses
200

Successful Response

resultsBulkOperationResult[]required

Detailed results for each entity

Show properties
Array of BulkOperationResult
idstringrequired

Entity ID

successbooleanrequired

Whether the operation succeeded

messagestring | null

Success message or error details

Show properties
Any of:
string
string
null
null
dataobject | null

Optional data returned by the operation

Show properties
Any of:
object
object
null
null
summaryBulkOperationSummaryrequired

Summary statistics for a bulk operation.

Show properties
totalintegerrequired

Total number of entities processed

succeededintegerrequired

Number of successful operations

failedintegerrequired

Number of failed operations

422

Validation Error

detailValidationError[]
Show properties
Array of ValidationError
locstring | integer[]required
Show properties
Array of string | integer
Any of:
string
string
integer
integer
msgstringrequired
typestringrequired
inputany
ctxobject
Request
curl -X POST 'https://api.streamkap.com/sources/bulk/parallel-snapshot' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "ids": [
    "string"
  ],
  "select_all": false,
  "filters": {
    "source_id": "string",
    "destination_id": "string"
  }
}'
Response
{
  "results": [
    {
      "id": "string",
      "success": true,
      "message": "string",
      "data": {}
    }
  ],
  "summary": {
    "total": 0,
    "succeeded": 0,
    "failed": 0
  }
}