Skip to main content
GET
Get Pipelines

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id
string | null
partial_name
string | null
tag_ids
string | null
tag_filter_operation
enum<string> | null
default:or

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

Available options:
and,
or
page
integer
default:1
page_size
integer
default:10
sort
string | null

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

sort_dir
string
default:asc

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

source_id
string | null
destination_id
string | null
status
string | null

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

latency
string | null

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

lag
string | null

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
enum<string>
default:false
Available options:
true,
false

Body

application/json

Body model for POST /pipelines/search requests.

Supports large lists of filter values that would exceed URL length limits when using GET. Body parameters take precedence over query parameters when both are provided.

tag_ids

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

tag_filter_operation
enum<string> | null

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

Available options:
and,
or
source_id

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

destination_id

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

status

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

Response

Successful Response

Get paginated Pipelines response.

result
PipelineBasic · object[]
required
page
integer
default:1

Current page number

page_size
integer
default:10

Results per page

total
integer | null

Total number of results

has_next
boolean | null

Whether more pages exist