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

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

organizationId
string<uuid>
obrigatório

ID of the organization that owns the service.

serviceId
string<uuid>
obrigatório

ID of the service to create the ClickPipe for.

clickPipeId
string<uuid>
obrigatório

ID of the requested ClickPipe.

Corpo

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

Resposta

Successful response

status
number

HTTP status code.

Exemplo:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
Última modificação em 24 de julho de 2026