Skip to main content
GET
/
pipelines
Get Pipelines
curl --request GET \
  --url https://api.streamkap.com/pipelines \
  --header 'Authorization: Bearer <token>'
{
  "result": [
    {
      "name": "<string>",
      "sub_id": "<string>",
      "tenant_id": "<string>",
      "id": "<string>",
      "snapshot_new_tables": true,
      "topic_ids": [
        "<string>"
      ],
      "topics": [
        "<string>"
      ],
      "source": {
        "name": "<string>",
        "connector": "<string>",
        "id": "<string>",
        "connector_display_name": "<string>",
        "created_timestamp": "<string>",
        "sub_id": "<string>",
        "tenant_id": "<string>",
        "service_id": "<string>",
        "config": {},
        "topic_ids": [
          "<string>"
        ],
        "topic_map": {},
        "topics": [
          "<string>"
        ],
        "tasks": [
          123
        ],
        "connector_status": "<string>",
        "task_statuses": {}
      },
      "destination": {
        "name": "<string>",
        "connector": "<string>",
        "id": "<string>",
        "connector_display_name": "<string>",
        "created_timestamp": "<string>",
        "sub_id": "<string>",
        "tenant_id": "<string>",
        "config": {},
        "topic_ids": [
          "<string>"
        ],
        "topic_map": {},
        "topics": [
          "<string>"
        ],
        "tasks": [
          123
        ],
        "connector_status": "<string>",
        "task_statuses": {}
      },
      "transforms": [
        "<unknown>"
      ],
      "tags": [],
      "periodic_audit": {
        "topics": [
          "<string>"
        ],
        "timestamp_column": "<string>",
        "interval_minutes": 123
      }
    }
  ],
  "page": 1,
  "page_size": 10,
  "total": 123,
  "has_next": true
}

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
​
page
integer
default:1
​
page_size
integer
default:10
​
sort
string
default:asc
​
source_id
string | null
​
destination_id
string | null
​
secret_returned
enum<string>
default:false
Available options:
true,
false

Response

Successful Response

Get paginated Pipelines response.

​
result
PipelineBasic · object[]
required
​
page
integer
default:1
​
page_size
integer
default:10
​
total
integer | null
​
has_next
boolean | null