Skip to main content
GET
List ClickPipes
Returns the ClickPipes in the specified service. If neither limit nor cursor is provided, returns all ClickPipes. In this case, limit and totalCount both equal the number of ClickPipes, and nextCursor is null. To paginate results, provide limit or cursor. Paginated results are sorted by creation date in descending order. Use limit to set the page size (default: 50). The server caps limit at its maximum page size and may return fewer results. Each response includes limit, totalCount, and nextCursor. To retrieve the next page, pass nextCursor as the cursor query parameter. Continue until nextCursor is null.

Permission

The API key must have the control-plane:service:manage-clickpipes permission.

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationId
string<uuid>
required

ID of the organization that owns the service.

serviceId
string<uuid>
required

ID of the service that owns the ClickPipe.

Query Parameters

limit
integer

Maximum number of results to return.

Required range: x >= 1
cursor
string

Opaque cursor from a previous response's nextCursor, marking where to resume the list.

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object[]
limit
integer

Maximum number of results returned in this page.

totalCount
integer | null

Total number of results across all pages. It has only informative value, thus is not guaranteed and it is provided on a best-effort basis. Null if the total count is unknown.

nextCursor
string | null

Cursor for the next page, to be sent as the cursor query parameter. Null on the last page.