Skip to content
Streamkap
Esc
navigateopen⌘Jpreview

Bulk Snapshot Topics

Execute snapshot for selected topics, grouped by their source connector.

Accepts topic DB IDs, resolves them to their source connectors, and triggers per-source snapshots scoped to only the selected topics (via topic_names).

Only topics produced by source connectors can be snapshotted - topics from transforms, destinations, or manually created topics are skipped.

Supports both incremental (default) and blocking snapshot types:

  • incremental: Uses watermarking to capture data while streaming continues.
  • blocking: Pauses streaming during snapshot. Required for keyless tables.

Results are reported per source connector, since snapshots are source-level operations. Returns partial success results - continues processing even if individual snapshots fail.

POST/topics/bulk/snapshot
Authorization
AuthorizationBearer token · headerrequired
Request body
requiredapplication/json
topic_idsstring[]required

List of topic DB IDs (_id) to operate on.

min items 1 · max items 500
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/topics/bulk/snapshot" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "topic_ids": [
    "string"
  ],
  "snapshot_type": "incremental"
}'
Response
{
  "results": [
    {
      "id": "string",
      "success": true,
      "message": "string",
      "data": {}
    }
  ],
  "summary": {
    "total": 0,
    "succeeded": 0,
    "failed": 0
  }
}