STstreamkap
Pipelines

Search pipelines (POST)

Changed on

POST alternative for GET /pipelines. 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/pipelines/search

Request

Query parameters

idstring nullable
partial_namestring nullable
tag_idsstring nullable
tag_filter_operation'and' | 'or' nullable

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

pageinteger
page_sizeinteger
sortstring nullable

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

sort_dirstring

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

source_idstring nullable
destination_idstring nullable
statusstring nullable

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

latencystring nullable

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

lagstring nullable

Filter by pipeline lag (records behind). Format: 'operator:value' (e.g., 'gt:100', 'lt:50'). Valid operators: gt (>), lt (<), gte (>=), lte (<=), eq (=), ne (!=)

secret_returned'true' | 'false'

Request body

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

Changes

  • 50e54c2e65f2Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status