ClickHouse Click Pipes API
The ClickPipes API from ClickHouse — 10 operation(s) for clickpipes.
Operations 18
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes
List a service's ClickPipes · List ClickPipes
#
Ask an LLM
“Which ClickPipes are ingesting data into my ClickHouse service?”
“Can I see all the ingestion pipes set up on one service?”
Tell an agent
List all ClickPipes on service {service} in org {org}.
Show every ingestion pipe feeding service {service} in organization {org}.
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes
Create a ClickPipe to ingest data · Create ClickPipe
#
Ask an LLM
“How do I start streaming data from a source into a ClickHouse table?”
“Can I set up a new pipe with custom field mappings to my destination table?”
Tell an agent
Create a ClickPipe named {name} on service {service} in org {org} reading from {source}.
Set up a new pipe on service {service} in organization {org} from {source} into destination {destination} with field mappings {fieldMappings}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/context
Get a service's ClickPipes capabilities and identity · Get ClickPipes service context
#
Ask an LLM
“Which GCP service account do I need to grant access to my source for ClickPipes?”
“What ClickPipes capabilities does this particular service support?”
Tell an agent
Get the ClickPipes service context for service {service} in org {org}.
Show the workload identity service account ClickPipes uses for service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}
Get details of one ClickPipe · Get ClickPipe
#
Ask an LLM
“What is the current state and source of a specific ClickPipe?”
“Is one of my pipes running, stopped or failed?”
Tell an agent
Show ClickPipe {pipe} on service {service} in org {org}.
Check the status and scaling of pipe {pipe} on service {service} in organization {org}.
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}
Update a ClickPipe's name, source or mappings · Update ClickPipe
#
Ask an LLM
“Which source fields can I still change after a pipe is created?”
“How do I rename a ClickPipe or adjust its field mappings?”
Tell an agent
Rename ClickPipe {pipe} on service {service} in org {org} to {name}.
Change the field mappings of existing pipe {pipe} on service {service} in organization {org} to {fieldMappings}.
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}
Delete a ClickPipe · Delete ClickPipe
#
Ask an LLM
“How do I permanently remove an ingestion pipe I no longer need?”
“Can I tear down a ClickPipe instead of just stopping it?”
Tell an agent destructive · confirm first
Delete ClickPipe {pipe} from service {service} in org {org}.
Remove pipe {pipe} on service {service} in organization {org} for good.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings
Get a ClickPipe's advanced settings · Get ClickPipe settings
#
Ask an LLM
“What advanced tuning settings are applied to one of my ClickPipes?”
“What insert thread and wait-time settings is my pipe using right now?”
Tell an agent
Show the advanced settings of ClickPipe {pipe} on service {service} in org {org}.
Get the tuning parameters for pipe {pipe} on service {service} in organization {org}.
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings
Tune a ClickPipe's advanced settings · Update ClickPipe settings
#
Ask an LLM
“Can I make a streaming pipe wait longer before inserting to batch bigger blocks?”
“How do I raise the number of insert threads a ClickPipe uses?”
Tell an agent
Set streaming max insert wait to {streaming_max_insert_wait_ms} ms on ClickPipe {pipe} on service {service} in org {org}.
Use {clickhouse_max_insert_threads} insert threads for pipe {pipe} on service {service} in organization {org}.
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/schemaDiscovery
Infer the schema of a ClickPipe source · Discover ClickPipe source schema
#
Ask an LLM
“Can ClickHouse detect the column names and types in my source before I build a pipe?”
“What ClickHouse data types would my incoming data map to?”
Tell an agent
Discover the schema of source {source} for service {service} in org {org}.
Infer field names and ClickHouse types from {source} before creating a pipe on service {service} in organization {org}.
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/scaling
Scale a streaming or object storage ClickPipe · Update ClickPipe scaling
#
Ask an LLM
“How do I add more replicas to a Kafka or Kinesis pipe that's falling behind?”
“Can I give an S3 ingestion pipe more CPU and memory per replica?”
Tell an agent
Scale ClickPipe {pipe} on service {service} in org {org} to {replicas} replicas.
Give each replica of pipe {pipe} on service {service} in organization {org} {replicaCpuMillicores} millicores and {replicaMemoryGb} GB.
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/state
Start, stop or resync a ClickPipe · Update ClickPipe state
#
Ask an LLM
“How do I pause a ClickPipe and restart it later?”
“Can I restart a pipe that's in a failed state?”
Tell an agent
Stop ClickPipe {pipe} on service {service} in org {org}.
Send command {command} to pipe {pipe} on service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling
Get shared scaling for database CDC ClickPipes · Get CDC ClickPipes scaling
#
Ask an LLM
“How much compute is allocated to my Postgres and MySQL CDC pipes?”
“What CPU and memory do the database ClickPipes on a service share?”
Tell an agent
Show the CDC ClickPipes scaling for service {service} in org {org}.
Get the shared CPU and memory settings for database pipes on service {service} in organization {org}.
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling
Resize shared compute for database CDC ClickPipes · Update CDC ClickPipes scaling
#
Ask an LLM
“How do I give my Postgres CDC replication more CPU and memory?”
“Can I scale down the infrastructure shared by all database pipes on a service?”
Tell an agent
Set CDC ClickPipes on service {service} in org {org} to {replicaCpuMillicores} millicores and {replicaMemoryGb} GB.
Increase memory for database CDC pipes on service {service} in organization {org} to {replicaMemoryGb} GB.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints
List reverse private endpoints for ClickPipes · List reverse private endpoints
#
Ask an LLM
“Which reverse private endpoints are set up for private ClickPipes connectivity?”
“Can I see all the private links ClickPipes uses to reach my sources?”
Tell an agent
List reverse private endpoints on service {service} in org {org}.
Show all private connections ClickPipes uses for service {service} in organization {org}.
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints
Create a reverse private endpoint for ClickPipes · Create reverse private endpoint
#
Ask an LLM
“How do I let ClickPipes reach my Kafka cluster over a private link instead of the internet?”
“Can I connect ClickPipes to an MSK cluster or a VPC endpoint service privately?”
Tell an agent
Create a reverse private endpoint of type {type} on service {service} in org {org} for VPC endpoint service {vpcEndpointServiceName}.
Set up a private endpoint to MSK cluster {mskClusterArn} for service {service} in organization {org}.
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}
Get one reverse private endpoint · Get reverse private endpoint
#
Ask an LLM
“What's the status of a specific reverse private endpoint I created?”
“Which DNS mappings are on one of my ClickPipes private endpoints?”
Tell an agent
Show reverse private endpoint {endpoint} on service {service} in org {org}.
Check the configuration of private endpoint {endpoint} for service {service} in organization {org}.
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}
Delete a reverse private endpoint · Delete reverse private endpoint
#
Ask an LLM
“How do I remove a reverse private endpoint that ClickPipes no longer needs?”
“Can I delete a private link to one of my ingestion sources?”
Tell an agent destructive · confirm first
Delete reverse private endpoint {endpoint} from service {service} in org {org}.
Tear down private endpoint {endpoint} used by ClickPipes on service {service} in organization {org}.
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}
Change a reverse private endpoint's DNS mappings · Update reverse private endpoint
#
Ask an LLM
“How do I update the custom private DNS mappings on a reverse private endpoint?”
“Can I clear all DNS mappings from an existing private endpoint?”
Tell an agent
Replace the DNS mappings on reverse private endpoint {endpoint} for service {service} in org {org} with {customPrivateDnsMappings}.
Clear every custom DNS mapping from private endpoint {endpoint} on service {service} in organization {org}.