Bulk Stop Snapshot Topics

Stop snapshot for sources identified by the selected topics.

Accepts topic DB IDs, resolves them to their source connectors, and stops any running snapshots on those sources.

Note: Because snapshots run at the source level, stopping affects all topics for that source, not just the selected ones.

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.

Returns partial success results - continues processing even if individual stop operations fail.

POST/topics/bulk/stop-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

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/stop-snapshot" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "topic_ids": [
    "string"
  ]
}'

const response = await fetch("https://api.streamkap.com/topics/bulk/stop-snapshot", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"topic_ids\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.streamkap.com/topics/bulk/stop-snapshot",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"topic_ids\": [\n    \"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": {}
    }
  ]
}