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.

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 that owns the ClickPipe.

clickPipeId
string<uuid>
obrigatório

ID of the ClickPipe to update state.

Corpo

application/json
command
enum<string>

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

Opções disponíveis:
start,
stop,
resync

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