Update Existing Pipeline

PUT /pipelines/{pipeline_id}

Update Existing Pipeline

cURL

curl --request PUT \
  --url https://api.streamkap.com/pipelines/{pipeline_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "destination": {
    "connector": "<string>",
    "name": "<string>",
    "id": "<string>"
  },
  "source": {
    "connector": "<string>",
    "name": "<string>",
    "id": "<string>",
    "topics": [
      "<string>"
    ]
  },
  "tags": [
    "<string>"
  ],
  "transforms": [
    {
      "topic_id": "<string>"
    }
  ],
  "periodic_audit": {
    "topics": [
      "<string>"
    ],
    "timestamp_column": "<string>",
    "interval_minutes": 123,
    "fix_deletes_only": false
  },
  "topic_auto_discovery_transforms": []
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

pipeline_id · string | null · required

Query Parameters

secret_returned · boolean · default: false

Whether to include secret values in the response

wait · boolean · default: true

When False, defer destination config update to reconciler instead of calling KC directly

Body

application/json

name · string · required

destination · PipelineDestinationConnector · object · required

Show child attributes

source · PipelineSourceConnector · object · required

Show child attributes

tags · string[] · required

transforms · PipelineTransformConnector · object[] | null

Show child attributes

periodic_audit · UpdatePipelineAuditReq · object

Update pipeline audit request.

Show child attributes

topic_auto_discovery_transforms · TopicAutoDiscoveryTransform · object[]

Show child attributes

Response

200

application/json

Successful Response