Skip to main content
PATCH
Update ClickPipe state
Start, stop or resync ClickPipe. Stopping a ClickPipe will stop the ingestion process from any state. Starting is allowed for ClickPipes in the “Stopped” state or with a “Failed” state. Resyncing is only for Postgres and MySQL pipes and can be done from any state.

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

organizationId
string<uuid>
requerido

ID of the organization that owns the service.

serviceId
string<uuid>
requerido

ID of the service that owns the ClickPipe.

clickPipeId
string<uuid>
requerido

ID of the ClickPipe to update state.

Cuerpo

application/json
command
enum<string>

Command to change the state: 'start', 'stop', 'resync'.

Opciones disponibles:
start,
stop,
resync

Respuesta

Successful response

status
number

HTTP status code.

Ejemplo:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
Última modificación el 24 de julio de 2026