POST
/
pipelines
Create New Pipeline
curl --request POST \
  --url https://api.streamkap.com/pipelines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "snapshot_new_tables": false,
  "destination": {
    "connector": "<string>",
    "name": "<string>",
    "id": "<string>"
  },
  "source": {
    "connector": "<string>",
    "name": "<string>",
    "id": "<string>",
    "topics": [
      "<string>"
    ]
  },
  "transforms": [
    {
      "topic_id": "<string>"
    }
  ],
  "tags": [
    "<string>"
  ],
  "created_from": "terraform"
}'
{
  "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": [
    "<any>"
  ],
  "tags": [
    "<string>"
  ],
  "periodic_audit": {
    "topics": [
      "<string>"
    ],
    "timestamp_column": "<string>",
    "interval_minutes": 123
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

secret_returned
boolean
default:false

Body

application/json
name
string
required
destination
object
required
source
object
required
tags
string[]
required
snapshot_new_tables
boolean
default:false
transforms
PipelineTransformConnector · object[] | null
created_from
enum<string> | null
default:api
Available options:
terraform,
web,
api

Response

Successful Response

name
string | null
sub_id
string | null
tenant_id
string | null
id
string | null
snapshot_new_tables
boolean | null
topic_ids
Topic Ids · array
topics
Topics · array
source
object | null

Basic source connector details.

destination
object | null

Basic destination connector details.

transforms
any[] | null
tags
string[] | null
periodic_audit
object | null

Update pipeline audit request.