Skip to main content
PATCH
Update ClickPipe
Update the specified ClickPipe.

承認

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年7月24日