v1

OpenAPI 3.1.0Proprietary2026-07-13197242444.9 KB
Sources

Search sources (POST)

POST alternative for GET /sources. Use when URL length limits are exceeded (e.g., many filter values). Supports both query parameters and request body. Body parameters take precedence over query parameters.

post/sources/search

Query parameters

pageinteger

Page number (1-indexed)

Page number (1-indexed)

page_sizeinteger

Number of results per page (max 100)

Number of results per page (max 100)

sortstring nullable

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

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

sort_dir'asc' | 'desc'

Sort direction for list/pagination requests.

Example: >>> SortDirectionEnum.asc 'asc' >>> sort_dir = SortDirectionEnum.desc >>> f"ORDER BY name {sort_dir.upper()}" 'ORDER BY name DESC'

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

string
OR
object

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

string
OR
object

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

idstring nullable
partial_namestring nullable
connectorstring nullable

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

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

statusstring nullable

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

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

latencystring nullable

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

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 nullable

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

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

etastring nullable

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.

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 nullable

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

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

tag_idsstring nullable

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

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

tag_filter_operation'and' | 'or' nullable

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

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

Request body

staleboolean nullable

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

tag_filter_operation'and' | 'or' nullable

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

Response

Successful Response

pageinteger

Current page number

page_sizeinteger

Results per page

totalinteger nullable

Total number of results

has_nextboolean nullable

Whether more pages exist