ClickHouse

ClickHouse UDF API

The UDF API from ClickHouse — 7 operation(s) for udf.

GitHub OpenAPI

Operations 12

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

PUT /v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId} Attach a UDF version to a service · Attach UDF to service #
Ask an LLM
“How do I make a user-defined function available on one of my services?”
“If I don't specify a version, which UDF version gets attached?”
Tell an agent
Attach UDF {functionName} to service {service} in org {org}.
Attach version {version} of function {functionName} to service {service} in organization {org}.
GET /v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId} Check a UDF's attachment to one service · Get UDF attachment #
Ask an LLM
“Which version of a user-defined function is attached to a particular service?”
“Is my UDF currently attached to this service?”
Tell an agent
Get the attachment of UDF {functionName} to service {service} in org {org}.
Show which version of function {functionName} runs on service {service} in organization {org}.
DELETE /v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId} Detach a UDF from a service · Detach UDF from service #
Ask an LLM
“How do I remove a user-defined function from just one service?”
“Can I stop a UDF running on a service without deleting the function?”
Tell an agent destructive · confirm first
Detach UDF {functionName} from service {service} in org {org}.
Unhook function {functionName} from service {service} in organization {org}, keeping the UDF itself.
GET /v1/organizations/{organizationId}/udfs/{functionName}/attachments List the services a UDF is attached to · List UDF attachments #
Ask an LLM
“Which services is a given user-defined function attached to?”
“Can I page through a UDF's attachments with a cursor?”
Tell an agent
List all service attachments for UDF {functionName} in org {org}.
Show {limit} attachments of function {functionName} in organization {org} after cursor {cursor}.
POST /v1/organizations/{organizationId}/udfs Create a new UDF · Create UDF #
Ask an LLM
“How do I create a brand-new user-defined function in ClickHouse Cloud?”
“What's the first step to deploy my own function code as a UDF?”
Tell an agent
Create a new UDF in organization {org}.
Register a brand-new user-defined function for org {org} from my uploaded archive.
GET /v1/organizations/{organizationId}/udfs List the organization's UDFs · List UDFs #
Ask an LLM
“What user-defined functions exist in my ClickHouse Cloud organization?”
“Can I see the latest version of every UDF we've built?”
Tell an agent
List all UDFs in organization {org}.
Show {limit} user-defined functions in org {org} starting at cursor {cursor}.
DELETE /v1/organizations/{organizationId}/udfs/{functionName} Delete a UDF and all its versions · Delete UDF #
Ask an LLM
“How do I delete a user-defined function everywhere it's used?”
“Does deleting a UDF also detach it from every service?”
Tell an agent destructive · confirm first
Delete UDF {functionName} and all its versions in org {org}.
Remove function {functionName} entirely from organization {org}, detaching it from all services.
GET /v1/organizations/{organizationId}/udfs/{functionName} Get the latest version of a UDF · Get UDF #
Ask an LLM
“What is the latest version of a particular user-defined function?”
“Is my UDF's newest build ready?”
Tell an agent
Get UDF {functionName} in org {org}.
Show the latest version details for function {functionName} in organization {org}.
POST /v1/organizations/{organizationId}/udfUploads/url Get a presigned URL to upload UDF code · Create UDF upload URL #
Ask an LLM
“Where do I upload the zip archive containing my UDF source code?”
“Can I reuse an upload URL if creating my UDF fails?”
Tell an agent
Create a UDF upload URL for organization {org}.
Give me a fresh presigned zip upload link for UDF code in org {org}.
POST /v1/organizations/{organizationId}/udfs/{functionName}/versions Build a new version of an existing UDF · Create UDF version #
Ask an LLM
“How do I ship updated code for a user-defined function that already exists?”
“Does a new UDF version inherit configuration from the previous version?”
Tell an agent
Create a new version of UDF {functionName} in org {org} from my uploaded archive.
Start a build of the next version of function {functionName} in organization {org}.
GET /v1/organizations/{organizationId}/udfs/{functionName}/versions List every version of a UDF · List UDF versions #
Ask an LLM
“What versions of a user-defined function have been built?”
“Can I see the full version history of one UDF?”
Tell an agent
List all versions of UDF {functionName} in org {org}.
Show {limit} versions of function {functionName} in organization {org} after cursor {cursor}.
DELETE /v1/organizations/{organizationId}/udfs/{functionName}/versions/{version} Delete one version of a UDF · Delete UDF version #
Ask an LLM
“How do I delete an old version of a user-defined function?”
“Can I remove a UDF version while it's still attached to a service?”
Tell an agent destructive · confirm first
Delete version {version} of UDF {functionName} in org {org}.
Remove build {version} of function {functionName} from organization {org}.

Documentation

📖
Documentation
https://clickhouse.com/docs/cloud/manage/api/api-overview
📖
APIReference
https://clickhouse.com/docs/products/cloud/api-reference/organization/get-list-of-available-organizations

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/openapi/clickhouse-udf-api-openapi.yml

Other Resources

🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/mcp/clickhouse-tool-crosswalk.yml
🔗
Swagger
https://clickhouse.com/docs/cloud/manage/api/swagger

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/clickhouse:clickhouse-udf-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

clickhouse-udf-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI spec for ClickHouse Cloud UDF API
  version: '1.0'
  contact:
    name: ClickHouse Support
    url: https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1107336
    email: support@clickhouse.com
servers:
- url: https://api.clickhouse.cloud
security:
- basicAuth: []
tags:


# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/openapi/clickhouse-udf-api-openapi.yml