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
마지막 수정일 2026년 7월 24일