Get Sources

GET/sources

Authorization

AuthorizationBearer token · headerrequired

Query parameters

pageinteger

Page number (1-indexed)

default: 1

page_sizeinteger

Number of results per page (max 100)

default: 10

sortstring

Sort field. Can be a DB field (name, created_at) or a metric field (latency, connector_status, recordsLag)

sort_dirSortDirectionEnum

Sort direction: 'asc' (ascending) or 'desc' (descending)

default: "asc"

Allowed:ascdesc

last_seen_offsetsstring | object

Last seen offsets for topic messages pagination (cursor-based)

first_seen_offsetsstring | object

First seen offsets for topic messages pagination (cursor-based)

idstring

partial_namestring

connectorstring

Filter by connector type. Comma-separated for multiple connectors (e.g., 'postgresql', 'postgresql,mysql,mongodb')

connector_notstring

Exclude connector types. Comma-separated. Returns sources whose connector is NOT in the list — the complement of connector, for callers that cannot enumerate every code to include.

statusstring

Filter by connector status. Comma-separated for multiple statuses (e.g., 'Active', 'Active,Paused'). Valid statuses: Active, Broken, Throttled, Paused, Stopped, Starting, Unassigned, Unknown

latencystring

Filter by latency in milliseconds. Format: 'operator:value' (e.g., 'gt:1000', 'lt:500', 'gte:100'). Valid operators: gt (>), lt (<), gte (>=), lte (<=), eq (=), ne (!=)

snapshotstring

Filter by snapshot status. Comma-separated for multiple statuses (e.g., 'running', 'completed,failed'). Valid statuses: running, completed, failed, pending, cancelled

etastring

Filter by snapshot ETA in milliseconds. Format: 'operator:value' (e.g., 'gt:60000', 'lte:300000'). Valid operators: gt (>), lt (<), gte (>=), lte (<=), eq (=), ne (!=). Sources without ETA (null/0) are excluded when filtering.

staleboolean

Filter by staleness. true = only sources with no data in 24h, false = only active sources.

tag_idsstring

Filter by tag IDs. Comma-separated list (e.g., 'tag1,tag2'). Use with tag_filter_operation to control AND/OR logic.

tag_filter_operationstring

Tag filter logic: 'or' (default) matches any tag, 'and' matches all tags.

default: "or"

Request body

application/json

Any of:

SourcesPaginatedReqBody

connectorstring[] | string | null

List of connector types (as array) or comma-separated string. Body takes precedence over query params.

Show properties

Any of:

string[]

Array of string

string

string

string

null

null

connector_notstring[] | string | null

Connector types to exclude (as array) or comma-separated string. Returns sources whose connector is NOT in the list. Body takes precedence over query params.

Show properties

Any of:

string[]

Array of string

string

string

string

null

null

statusstring[] | string | null

List of statuses (as array) or comma-separated string. Body takes precedence over query params.

Show properties

Any of:

string[]

Array of string

string

string

string

null

null

snapshotstring[] | string | null

List of snapshot statuses (as array) or comma-separated string. Body takes precedence over query params. Valid statuses: running, completed, failed, pending, cancelled

Show properties

Any of:

string[]

Array of string

string

string

string

null

null

staleboolean | null

Filter by staleness. true = only sources with no data in 24h, false = only active sources. Body takes precedence over query params.

Show properties

Any of:

boolean

boolean

null

null

tag_idsstring[] | string | null

List of tag IDs (as array) or comma-separated string. Body takes precedence over query params.

Show properties

Any of:

string[]

Array of string

string

string

string

null

null

tag_filter_operationstring | null

Tag filter logic: 'or' (default) matches any tag, 'and' matches all tags. Body takes precedence over query params.

Show properties

Any of:

string

string

null

null

null

null

Responses

200

Successful Response

pageinteger

Current page number

default: 1

page_sizeinteger

Results per page

default: 10

totalinteger | null

Total number of results

Show properties

Any of:

integer

integer

null

null

has_nextboolean | null

Whether more pages exist

Show properties

Any of:

boolean

boolean

null

null

resultSourceConnector[]required

Show properties

Array of SourceConnector

namestring | null

User-defined connector name

Show properties

Any of:

string

string

null

null

connectorstring | null

Connector type (e.g., 'postgresql', 'mysql', 'mongodb')

Show properties

Any of:

string

string

null

null

idstring | null

Unique identifier

Show properties

Any of:

string

string

null

null

connector_display_namestring | null

Human-readable connector type name

Show properties

Any of:

string

string

null

null

created_timestampstring | string<date-time> | null

Creation timestamp (ISO 8601)

Show properties

Any of:

string

string

string<date-time>

string<date-time>

null

null

sub_idstring | null

Subscription identifier

Show properties

Any of:

string

string

null

null

tenant_idstring | null

Tenant identifier for multi-tenancy

Show properties

Any of:

string

string

null

null

service_idstring | null

Associated service identifier

Show properties

Any of:

string

string

null

null

configobject | null

The connector's configuration. Its properties per connector type are documented on the create and update requests' config.

Show properties

Any of:

object

object

null

null

topic_idsstring | integer[] | null

List of associated topic identifiers

Show properties

Any of:

string | integer[]

Array of string | integer

Any of:

string

string

integer

integer

null

null

topic_mapobject | null

Mapping of topics to their partitions or related entities

Show properties

Any of:

object

object

null

null

topicsstring | integer[] | null

List of topic names

Show properties

Any of:

string | integer[]

Array of string | integer

Any of:

string

string

integer

integer

null

null

tasksinteger[] | null

List of task identifiers

Show properties

Any of:

integer[]

Array of integer

integer

null

null

connector_statusstring | null

Current status: Active, Paused, Stopped, Broken, Starting, Unassigned, Unknown, Throttled (an api source waiting out its vendor's rate budget; task_statuses carries suspend_reason and resume_at), or a Pending* state echoed from desired_state while a requested change is being applied

Show properties

Any of:

string

string

null

null

desired_statestring | null

Desired state: Active, Paused, Stopped, or a pending change Streamkap is still applying — Pending, Pending Update, Pending Delete, Pending Stop, Pending Pause, Pending Resume, Pending Restart

Show properties

Any of:

string

string

null

null

reconcile_errorstring | null

Why the connector is Broken, as recorded when Streamkap last tried to apply its state. Secrets are masked; absent while the connector is healthy.

Show properties

Any of:

string

string

null

null

connection_warningstring | null

API sources, on the create and update responses only: what the credential and resource checks found that did not stop the save but needs action, e.g. an ad account that is not active, an access token that expires within 14 days, or a resource that returned no rows (each resource's warning prefixed with its name, <resource>: <warning>). The same texts Test connection returns as its message and as each passing resource's warning. Absent when there is nothing to report.

Show properties

Any of:

string

string

null

null

kc_cluster_idstring | null

Kafka Connect cluster this connector is deployed to. None means the default cluster.

Show properties

Any of:

string

string

null

null

task_statusesobject | null

Status information for each connector task

Show properties

Any of:

object

object

null

null

tagsstring[] | null

List of tag IDs assigned to this source

Show properties

Any of:

string[]

Array of string

string

null

null

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 GET 'https://api.streamkap.com/sources' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "connector": [
    "string"
  ],
  "connector_not": [
    "string"
  ],
  "status": [
    "string"
  ],
  "snapshot": [
    "string"
  ],
  "stale": true,
  "tag_ids": [
    "string"
  ],
  "tag_filter_operation": "and"
}'

const response = await fetch("https://api.streamkap.com/sources", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"connector\": [\n    \"string\"\n  ],\n  \"connector_not\": [\n    \"string\"\n  ],\n  \"status\": [\n    \"string\"\n  ],\n  \"snapshot\": [\n    \"string\"\n  ],\n  \"stale\": true,\n  \"tag_ids\": [\n    \"string\"\n  ],\n  \"tag_filter_operation\": \"and\"\n}"
});

import requests

response = requests.get(
    "https://api.streamkap.com/sources",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"connector\": [\n    \"string\"\n  ],\n  \"connector_not\": [\n    \"string\"\n  ],\n  \"status\": [\n    \"string\"\n  ],\n  \"snapshot\": [\n    \"string\"\n  ],\n  \"stale\": true,\n  \"tag_ids\": [\n    \"string\"\n  ],\n  \"tag_filter_operation\": \"and\"\n}",
)

Response

{
  "page": 1,
  "page_size": 10,
  "total": 0,
  "has_next": true,
  "result": [
    {
      "name": "string",
      "connector": "string",
      "id": "string",
      "connector_display_name": "string",
      "created_timestamp": "string",
      "sub_id": "string",
      "tenant_id": "string",
      "service_id": "string",
      "config": {
        "property1": "string",
        "property2": "string"
      },
      "topic_ids": [
        "string"
      ],
      "topic_map": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "topics": [
        "string"
      ],
      "tasks": [
        0
      ],
      "connector_status": "string",
      "desired_state": "string",
      "reconcile_error": "string",
      "connection_warning": "string",
      "kc_cluster_id": "string",
      "task_statuses": {
        "property1": {
          "property1": "string",
          "property2": "string"
        },
        "property2": {
          "property1": "string",
          "property2": "string"
        }
      },
      "tags": [
        "string"
      ]
    }
  ]
}

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