Skip to main content
PATCH
Update ClickPipe
Update the specified ClickPipe. Source fields not present in the per-source update schemas are immutable after creation. For Kafka sources, values submitted for immutable fields (type, format, brokers, topics, consumerGroup, offset, schemaRegistry, exactlyOnce) are not applied, except schema registry credentials, which are rejected.

인증

Authorization
string
header
필수

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

경로 매개변수

organizationId
string<uuid>
필수

ID of the organization that owns the service.

serviceId
string<uuid>
필수

ID of the service to create the ClickPipe for.

clickPipeId
string<uuid>
필수

ID of the requested ClickPipe.

본문

application/json
name
string | null

Name of the ClickPipe.

source
object | null
destination
object | null
fieldMappings
object[]

Field mappings of the ClickPipe. This will not update the table schema, only the ClickPipe configuration.

settings
object | null

응답

Successful response

status
number

HTTP status code.

예시:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
마지막 수정일 2026년 8월 6일