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
آخر تعديل في ٦ أغسطس ٢٠٢٦