Skip to main content
POST
/
sources
/
cancel_snapshot
Cancel Snapshot
curl --request POST \
  --url https://api.streamkap.com/sources/cancel_snapshot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_id": "<string>",
  "topic_names": [
    "<string>"
  ],
  "additional_conditions": [
    {
      "data_collection": "<string>",
      "filter": "<string>"
    }
  ],
  "surrogate_key": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Execute Snapshot Body

source_id
string
required
topic_names
string[] | null
additional_conditions
AdditionalCondition · object[] | null
surrogate_key
string | null

Column name to use as surrogate primary key for all tables during snapshot chunking. Useful for tables without primary keys or when a more efficient column exists for chunking.

Response

Successful Response