v1

OpenAPI 3.1.0Proprietary2026-07-13197242444.9 KB
Topics

Search topics (POST)

POST alternative for GET /topics/details. Use when URL length limits are exceeded (e.g., 100+ entity IDs). Supports both query parameters and request body. Body parameters take precedence over query parameters.

post/topics/details/search

Query parameters

entity_typestring nullable

Filter by entity type(s). Single value (e.g., 'sources') or comma-separated (e.g., 'sources,transforms'). Valid types: sources, destinations, transforms, pipelines, manual.

Filter by entity type(s). Single value (e.g., 'sources') or comma-separated (e.g., 'sources,transforms'). Valid types: sources, destinations, transforms, pipelines, manual.

topic_idstring nullable
partial_namestring nullable

Topic id

Topic id

pageinteger
page_sizeinteger
entity_idstring nullable

Filter by specific entity IDs (comma-separated list)

Filter by specific entity IDs (comma-separated list)

include_dlqboolean

Include Dead Letter Queue (DLQ) topics in results. Set to false to exclude DLQ topics.

Include Dead Letter Queue (DLQ) topics in results. Set to false to exclude DLQ topics.

include_internalboolean

Local/admin-app only: include Streamkap/KC internal topics (streamkap_signal, streamkap_state, KC offsets/configs/status) in the result. Internal topics carry connector='internal:<klass>'.

Local/admin-app only: include Streamkap/KC internal topics (streamkap_signal, streamkap_state, KC offsets/configs/status) in the result. Internal topics carry connector='internal:<klass>'.

snapshotstring nullable

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

Filter topics 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 (!=). Topics 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 (!=). Topics without ETA (null/0) are excluded when filtering.

timestamp_fromstring nullable

Start timestamp for filtering topics by activity period (ISO 8601 format)

Start timestamp for filtering topics by activity period (ISO 8601 format)

timestamp_tostring nullable

End timestamp for filtering topics by activity period (ISO 8601 format)

End timestamp for filtering topics by activity period (ISO 8601 format)

time_type'timeseries' | 'timesummary' | 'latest' nullable

Time aggregation type for filtering active topics (only applies when timestamp_from/to are specified)

Time aggregation type for filtering active topics (only applies when timestamp_from/to are specified)

value_formatstring nullable

Filter by serialization value format. Valid values: avro, json, json_schema, protobuf, string, bytearray. Case-insensitive. Omit or pass null to return all formats.

Filter by serialization value format. Valid values: avro, json, json_schema, protobuf, string, bytearray. Case-insensitive. Omit or pass null to return all formats.

has_errorsboolean nullable

Filter topics by error status. true = only topics with recordErrorTotal > 0, false = only topics with recordErrorTotal == 0, null/omit = return all topics.

Filter topics by error status. true = only topics with recordErrorTotal > 0, false = only topics with recordErrorTotal == 0, null/omit = return all topics.

orphanedboolean nullable

Filter by orphaned status. true = only topics with 0 destinations, false = only topics with destinations.

Filter by orphaned status. true = only topics with 0 destinations, false = only topics with destinations.

partition_skewboolean nullable

Filter by partition skew. true = only topics where max partition lag > 2x average.

Filter by partition skew. true = only topics where max partition lag > 2x average.

sortstring nullable

Sort field. Valid values: DB fields (name, connector, entity_type, entity_name), snapshot_status (sources only), or Kafka-admin fields (partition_count, replication_factor, retention_ms, lastMessageTimestamp).

Sort field. Valid values: DB fields (name, connector, entity_type, entity_name), snapshot_status (sources only), or Kafka-admin fields (partition_count, replication_factor, retention_ms, lastMessageTimestamp).

sort_dir'asc' | 'desc'
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

value_formatstring nullable

Filter by serialization value format. Valid values: avro, json, json_schema, protobuf, string, bytearray. Case-insensitive. Body takes precedence over query params.

has_errorsboolean nullable

Filter topics by error status. true = only topics with errors, false = only topics without errors. Body takes precedence over query params.

orphanedboolean nullable

Filter by orphaned status. true = only topics with 0 destinations, false = only topics with destinations. Body takes precedence over query params.

partition_skewboolean nullable

Filter by partition skew. true = only topics where max partition lag > 2x average. 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