Bulk Stop Snapshot Sources

Stop snapshot on multiple sources in parallel.

Automatically detects the running snapshot type (incremental or blocking) and uses the appropriate cancellation method:

Incremental: Cancels via signal table, streaming continues
Blocking: Restarts the connector, streaming resumes after restart

Uses lower concurrency 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 stop operations fail.

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

const response = await fetch("https://api.streamkap.com/sources/bulk/stop-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}"
});

import requests

response = requests.post(
    "https://api.streamkap.com/sources/bulk/stop-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}",
)

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": {}
    }
  ]
}