Execute Parallel Snapshot

POST/sources/execute_parallel_snapshot

Authorization

AuthorizationBearer token · headerrequired

Request body

requiredapplication/json

source_idstringrequired

topic_namesstring[] | null

Show properties

Any of:

string[]

Array of string

string

null

null

additional_conditionsAdditionalCondition[] | null

Show properties

Any of:

AdditionalCondition[]

Array of AdditionalCondition

data_collectionstringrequired

The data collection (e.g., table or collection name) to apply the filter to.

filterstringrequired

The filter expression to apply to the data collection (e.g., createdAt > '2023-01-01').

null

null

surrogate_keysSurrogateKeySpec[] | null

Per-table surrogate key(s) for parallel filtered snapshots (ENG-2474): the indexed column(s) to range over instead of the PK. Distinct from the source-wide surrogate_key below (incremental / blocking path).

Show properties

Any of:

SurrogateKeySpec[]

Array of SurrogateKeySpec

data_collectionstringrequired

The data collection (table) to apply the surrogate key to.

surrogate_keystring[]required

Indexed column(s) to range + order over instead of the PK (single or composite).

null

null

surrogate_keystring | 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.

Show properties

Any of:

string

string

null

null

filter_regexstring | null

Optional restrictive regex applied by the orchestrator to the physical tables the controller expands, across ALL triggered selectors. Matched (via search) against each physical's fully-qualified identifier <database-or-schema>.<table>, so it can narrow by DB/schema, table name, or a table-name suffix — the caller decides. Only matching physicals are snapshotted. Use to backfill a specific subset without re-snapshotting a regex source's full expansion. Null → no restriction.

Show properties

Any of:

string

string

null

null

Responses

200

Successful Response

any

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/execute_parallel_snapshot' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "source_id": "string",
  "topic_names": [
    "string"
  ],
  "additional_conditions": [
    {
      "data_collection": "string",
      "filter": "string"
    }
  ],
  "surrogate_keys": [
    {
      "data_collection": "string",
      "surrogate_key": [
        "string"
      ]
    }
  ],
  "surrogate_key": "string",
  "filter_regex": "string"
}'

const response = await fetch("https://api.streamkap.com/sources/execute_parallel_snapshot", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"source_id\": \"string\",\n  \"topic_names\": [\n    \"string\"\n  ],\n  \"additional_conditions\": [\n    {\n      \"data_collection\": \"string\",\n      \"filter\": \"string\"\n    }\n  ],\n  \"surrogate_keys\": [\n    {\n      \"data_collection\": \"string\",\n      \"surrogate_key\": [\n        \"string\"\n      ]\n    }\n  ],\n  \"surrogate_key\": \"string\",\n  \"filter_regex\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.streamkap.com/sources/execute_parallel_snapshot",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"source_id\": \"string\",\n  \"topic_names\": [\n    \"string\"\n  ],\n  \"additional_conditions\": [\n    {\n      \"data_collection\": \"string\",\n      \"filter\": \"string\"\n    }\n  ],\n  \"surrogate_keys\": [\n    {\n      \"data_collection\": \"string\",\n      \"surrogate_key\": [\n        \"string\"\n      ]\n    }\n  ],\n  \"surrogate_key\": \"string\",\n  \"filter_regex\": \"string\"\n}",
)

Response

Successful Response

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