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:

Explicit IDs: Pass a list of source IDs
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

Authorization

AuthorizationBearer token · headerrequired

Request body

requiredapplication/json

idsstring[] | any

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

Show properties

Any of:

string[]

Array of string

string

any

any

select_allboolean

If true, select all entities matching the filters

default: false

filtersBulkSelectionFilter | any

Optional filters when select_all=true

Show properties

Any of:

BulkSelectionFilter

source_idstring | any

Filter by source ID (for pipelines/destinations)

Show properties

Any of:

string

string

any

any

destination_idstring | any

Filter by destination ID (for pipelines/destinations)

Show properties

Any of:

string

string

any

any

any

any

snapshot_typestring

Type of snapshot to execute. 'incremental' (default) uses watermarking while streaming continues. 'blocking' pauses streaming during snapshot - required for keyless tables.

default: "incremental"

Allowed:incrementalblocking

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

Success message or error details

Show properties

Any of:

string

string

any

any

dataobject | any

Optional data returned by the operation

Show properties

Any of:

object

object

any

any

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/snapshot" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    "string"
  ],
  "select_all": false,
  "filters": {
    "source_id": "string",
    "destination_id": "string"
  },
  "snapshot_type": "incremental"
}'

const response = await fetch("https://api.streamkap.com/sources/bulk/snapshot", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"ids\": [\n    \"string\"\n  ],\n  \"select_all\": false,\n  \"filters\": {\n    \"source_id\": \"string\",\n    \"destination_id\": \"string\"\n  },\n  \"snapshot_type\": \"incremental\"\n}"
});

import requests

response = requests.post(
    "https://api.streamkap.com/sources/bulk/snapshot",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"ids\": [\n    \"string\"\n  ],\n  \"select_all\": false,\n  \"filters\": {\n    \"source_id\": \"string\",\n    \"destination_id\": \"string\"\n  },\n  \"snapshot_type\": \"incremental\"\n}",
)

Response

{
  "results": [
    {
      "id": "string",
      "success": true,
      "message": "string",
      "data": {}
    }
  ],
  "summary": {
    "total": 0,
    "succeeded": 0,
    "failed": 0
  }
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}