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.

Авторизации

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

clickPipeId
string<uuid>
обязательно

ID of the ClickPipe to update state.

Тело

application/json
command
enum<string>

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

Доступные опции:
start,
stop,
resync

Ответ

Successful response

status
number

HTTP status code.

Пример:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
Последнее изменение 24 июля 2026 г.