You can wire the ClickHouse node into an AI agent as a tool provider: the agent calls the operations you allow. See Agent tools.
Credentials
Connect ClickHouse under Credentials in the node settings. See Connecting credentials for the general flow. Enter the values manually when creating the credential. Create an API key in the ClickHouse Cloud console under Settings -> API Keys -> New API Key. Choose a role (developer = read-only, admin = read/write). Copy the Key ID and Key Secret (the secret is shown only once). Get your credentials here.Operations
API keys
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create API Key | create_key | Create a new organization API key (returns Key ID + Secret). | |
| Delete API Key | delete_key | Delete/revoke an organization API key. | |
| List API Keys | list_keys | List organization API keys. |
Backups
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Get Backup | get_backup | Get details of a single backup. | |
| Get Backup Configuration | get_backup_configuration | Read the backup schedule/retention configuration for a service. | |
| List Backups | list_backups | List backups for a service. | |
| Update Backup Configuration | update_backup_configuration | Update a service’s backup schedule and retention settings. |
ClickPipes
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create ClickPipe | create_clickpipe | Create a ClickPipe data-ingestion pipeline. | |
| Delete ClickPipe | delete_clickpipe | Delete a ClickPipe. | |
| Get ClickPipe | get_clickpipe | Get details of a single ClickPipe. | |
| List ClickPipes | list_clickpipes | List ingestion pipelines (ClickPipes) for an organization. | |
| Update ClickPipe State | update_clickpipe_state | Start, stop, or pause a ClickPipe. |
Invitations
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Invitation | create_invitation | Invite a user to the organization. | |
| Delete Invitation | delete_invitation | Revoke a pending invitation. | |
| List Invitations | list_invitations | List pending organization invitations. |
Members
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Get Invitation | get_invitation | Get a single pending invitation. | |
| Get Member | get_member | Get a single organization member. | |
| List Members | list_members | List organization members. | |
| List Roles | list_roles | List custom roles defined in the organization (for orgs that have migrated to Custom Roles). | |
| Remove Member | remove_member | Remove a member from the organization. | |
| Update Member Role | update_member | Update a member’s role in the organization. |
Metrics
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Get Prometheus Metrics | get_prometheus_metrics | Scrape service metrics in Prometheus exposition format. |
Organizations
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Get Organization | get_organization | Get details of a single organization. | |
| Get Usage Cost | get_usage_cost | Retrieve usage/cost data for a date range. | |
| List Activities | list_activities | List the audit log of organization activities. | |
| List Organizations | list_organizations | List organizations the API key can access. | |
| Update Organization | update_organization | Update organization settings (e.g. name). |
Query endpoints
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create / Update Query Endpoint | upsert_query_endpoint | Create or update a query endpoint to run SQL against the service over HTTPS. | |
| Delete Query Endpoint | delete_query_endpoint | Delete the service’s query endpoint. | |
| Get Query Endpoint | get_query_endpoint | Get the SQL query endpoint config for a service. |
Services
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Service | create_service | Provision a new ClickHouse service. | |
| Delete Service | delete_service | Delete a service. | |
| Get Private Endpoint Config | get_private_endpoint_config | Get the private endpoint configuration info needed to connect via VPC. | |
| Get Service | get_service | Get details of a single service. | |
| List Services | list_services | List all ClickHouse services in an organization. | |
| Start / Stop Service | update_service_state | Start or stop a service. | |
| Update Service | update_service | Update service basics (name, etc.). | |
| Update Service Password | update_service_password | Reset the service’s default database user password. | |
| Update Service Replica Scaling | update_service_replica_scaling | Update service autoscaling, new endpoint replacing the deprecated /scaling path. | |
| Update Service Scaling | update_service_scaling | Update service autoscaling min/max replica memory. |
Triggers
| Operation | ID | Description | Trigger |
|---|---|---|---|
| On Scheduled Query Results | on_query_results | Poll-based trigger: runs on a schedule, fetches the organization activity audit log, and emits NEW activities since the last poll. | Yes |