Create UDF
Creates a new UDF. See User-defined functions in Cloud.
POST
/
v1
/
organizations
/
{organizationId}
/
udfs
Create UDF
curl --request POST \
--url https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"arguments": [
{
"name": "<string>",
"type": "<string>"
}
],
"returnType": "<string>",
"type": "executable",
"functionName": "<string>",
"returnName": "<string>",
"commandReadTimeout": 10000,
"commandWriteTimeout": 10000,
"memoryLimitMib": 524288,
"sendChunkHeader": false,
"deterministic": false,
"format": "TabSeparated",
"sandboxType": "basic",
"sandboxVersion": "v2",
"poolSize": null,
"maxCommandExecutionTime": 10
}
'import requests
url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"
payload = {
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"arguments": [
{
"name": "<string>",
"type": "<string>"
}
],
"returnType": "<string>",
"type": "executable",
"functionName": "<string>",
"returnName": "<string>",
"commandReadTimeout": 10000,
"commandWriteTimeout": 10000,
"memoryLimitMib": 524288,
"sendChunkHeader": False,
"deterministic": False,
"format": "TabSeparated",
"sandboxType": "basic",
"sandboxVersion": "v2",
"poolSize": None,
"maxCommandExecutionTime": 10
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
uploadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
arguments: [{name: '<string>', type: '<string>'}],
returnType: '<string>',
type: 'executable',
functionName: '<string>',
returnName: '<string>',
commandReadTimeout: 10000,
commandWriteTimeout: 10000,
memoryLimitMib: 524288,
sendChunkHeader: false,
deterministic: false,
format: 'TabSeparated',
sandboxType: 'basic',
sandboxVersion: 'v2',
poolSize: null,
maxCommandExecutionTime: 10
})
};
fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'uploadId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'arguments' => [
[
'name' => '<string>',
'type' => '<string>'
]
],
'returnType' => '<string>',
'type' => 'executable',
'functionName' => '<string>',
'returnName' => '<string>',
'commandReadTimeout' => 10000,
'commandWriteTimeout' => 10000,
'memoryLimitMib' => 524288,
'sendChunkHeader' => false,
'deterministic' => false,
'format' => 'TabSeparated',
'sandboxType' => 'basic',
'sandboxVersion' => 'v2',
'poolSize' => null,
'maxCommandExecutionTime' => 10
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"
payload := strings.NewReader("{\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"returnType\": \"<string>\",\n \"type\": \"executable\",\n \"functionName\": \"<string>\",\n \"returnName\": \"<string>\",\n \"commandReadTimeout\": 10000,\n \"commandWriteTimeout\": 10000,\n \"memoryLimitMib\": 524288,\n \"sendChunkHeader\": false,\n \"deterministic\": false,\n \"format\": \"TabSeparated\",\n \"sandboxType\": \"basic\",\n \"sandboxVersion\": \"v2\",\n \"poolSize\": null,\n \"maxCommandExecutionTime\": 10\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"returnType\": \"<string>\",\n \"type\": \"executable\",\n \"functionName\": \"<string>\",\n \"returnName\": \"<string>\",\n \"commandReadTimeout\": 10000,\n \"commandWriteTimeout\": 10000,\n \"memoryLimitMib\": 524288,\n \"sendChunkHeader\": false,\n \"deterministic\": false,\n \"format\": \"TabSeparated\",\n \"sandboxType\": \"basic\",\n \"sandboxVersion\": \"v2\",\n \"poolSize\": null,\n \"maxCommandExecutionTime\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"returnType\": \"<string>\",\n \"type\": \"executable\",\n \"functionName\": \"<string>\",\n \"returnName\": \"<string>\",\n \"commandReadTimeout\": 10000,\n \"commandWriteTimeout\": 10000,\n \"memoryLimitMib\": 524288,\n \"sendChunkHeader\": false,\n \"deterministic\": false,\n \"format\": \"TabSeparated\",\n \"sandboxType\": \"basic\",\n \"sandboxVersion\": \"v2\",\n \"poolSize\": null,\n \"maxCommandExecutionTime\": 10\n}"
response = http.request(request)
puts response.read_body{
"status": 201,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"functionName": "<string>",
"version": 1,
"status": "building",
"runtime": "python3.11",
"type": "executable",
"arguments": [
{
"name": "<string>",
"type": "<string>"
}
],
"returnType": "<string>",
"returnName": "<string>",
"poolSize": 1,
"commandReadTimeout": 123,
"commandWriteTimeout": 123,
"maxCommandExecutionTime": 1,
"memoryLimitMib": 524288,
"sendChunkHeader": true,
"deterministic": true,
"format": "<string>",
"sandboxType": "basic",
"sandboxVersion": "v1",
"error": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"status": 400,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>"
}
]
}{
"error": "<string>",
"status": 403,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": "<string>",
"status": 409,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": "<string>",
"status": 410,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": "<string>",
"status": 500,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Creates a new UDF. See User-defined functions in Cloud.
Permission
The API key must have the
control-plane:organization:manage permission.Autorizaciones
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi
Parámetros de ruta
ID of the requested organization.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$Cuerpo
application/json
- Option 1
- Option 2
Identifier of the uploaded source archive.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$Opciones disponibles:
python3.11, native Show child attributes
Show child attributes
Allowed value:
"executable"Pattern:
^[A-Za-z][A-Za-z0-9_]*$Pattern:
^[A-Za-z][A-Za-z0-9_]*$Rango requerido:
1 <= x <= 1048576Marks the UDF as deterministic so ClickHouse can reuse cached query results. Only set this when the UDF always returns the same result for the same arguments.
Opciones disponibles:
basic, netenable Opciones disponibles:
v1, v2, v3 Always null — an executable UDF has no command pool.
Rango requerido:
x > 0Respuesta
UDF created and building.
HTTP status code.
Ejemplo:
201
Unique id assigned to every request. UUIDv4
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$Show child attributes
Show child attributes
Última modificación el 3 de octubre de 2026
¿Esta página le ayudó?
⌘I
Create UDF
curl --request POST \
--url https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"arguments": [
{
"name": "<string>",
"type": "<string>"
}
],
"returnType": "<string>",
"type": "executable",
"functionName": "<string>",
"returnName": "<string>",
"commandReadTimeout": 10000,
"commandWriteTimeout": 10000,
"memoryLimitMib": 524288,
"sendChunkHeader": false,
"deterministic": false,
"format": "TabSeparated",
"sandboxType": "basic",
"sandboxVersion": "v2",
"poolSize": null,
"maxCommandExecutionTime": 10
}
'import requests
url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"
payload = {
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"arguments": [
{
"name": "<string>",
"type": "<string>"
}
],
"returnType": "<string>",
"type": "executable",
"functionName": "<string>",
"returnName": "<string>",
"commandReadTimeout": 10000,
"commandWriteTimeout": 10000,
"memoryLimitMib": 524288,
"sendChunkHeader": False,
"deterministic": False,
"format": "TabSeparated",
"sandboxType": "basic",
"sandboxVersion": "v2",
"poolSize": None,
"maxCommandExecutionTime": 10
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
uploadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
arguments: [{name: '<string>', type: '<string>'}],
returnType: '<string>',
type: 'executable',
functionName: '<string>',
returnName: '<string>',
commandReadTimeout: 10000,
commandWriteTimeout: 10000,
memoryLimitMib: 524288,
sendChunkHeader: false,
deterministic: false,
format: 'TabSeparated',
sandboxType: 'basic',
sandboxVersion: 'v2',
poolSize: null,
maxCommandExecutionTime: 10
})
};
fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'uploadId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'arguments' => [
[
'name' => '<string>',
'type' => '<string>'
]
],
'returnType' => '<string>',
'type' => 'executable',
'functionName' => '<string>',
'returnName' => '<string>',
'commandReadTimeout' => 10000,
'commandWriteTimeout' => 10000,
'memoryLimitMib' => 524288,
'sendChunkHeader' => false,
'deterministic' => false,
'format' => 'TabSeparated',
'sandboxType' => 'basic',
'sandboxVersion' => 'v2',
'poolSize' => null,
'maxCommandExecutionTime' => 10
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"
payload := strings.NewReader("{\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"returnType\": \"<string>\",\n \"type\": \"executable\",\n \"functionName\": \"<string>\",\n \"returnName\": \"<string>\",\n \"commandReadTimeout\": 10000,\n \"commandWriteTimeout\": 10000,\n \"memoryLimitMib\": 524288,\n \"sendChunkHeader\": false,\n \"deterministic\": false,\n \"format\": \"TabSeparated\",\n \"sandboxType\": \"basic\",\n \"sandboxVersion\": \"v2\",\n \"poolSize\": null,\n \"maxCommandExecutionTime\": 10\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"returnType\": \"<string>\",\n \"type\": \"executable\",\n \"functionName\": \"<string>\",\n \"returnName\": \"<string>\",\n \"commandReadTimeout\": 10000,\n \"commandWriteTimeout\": 10000,\n \"memoryLimitMib\": 524288,\n \"sendChunkHeader\": false,\n \"deterministic\": false,\n \"format\": \"TabSeparated\",\n \"sandboxType\": \"basic\",\n \"sandboxVersion\": \"v2\",\n \"poolSize\": null,\n \"maxCommandExecutionTime\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"returnType\": \"<string>\",\n \"type\": \"executable\",\n \"functionName\": \"<string>\",\n \"returnName\": \"<string>\",\n \"commandReadTimeout\": 10000,\n \"commandWriteTimeout\": 10000,\n \"memoryLimitMib\": 524288,\n \"sendChunkHeader\": false,\n \"deterministic\": false,\n \"format\": \"TabSeparated\",\n \"sandboxType\": \"basic\",\n \"sandboxVersion\": \"v2\",\n \"poolSize\": null,\n \"maxCommandExecutionTime\": 10\n}"
response = http.request(request)
puts response.read_body{
"status": 201,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"functionName": "<string>",
"version": 1,
"status": "building",
"runtime": "python3.11",
"type": "executable",
"arguments": [
{
"name": "<string>",
"type": "<string>"
}
],
"returnType": "<string>",
"returnName": "<string>",
"poolSize": 1,
"commandReadTimeout": 123,
"commandWriteTimeout": 123,
"maxCommandExecutionTime": 1,
"memoryLimitMib": 524288,
"sendChunkHeader": true,
"deterministic": true,
"format": "<string>",
"sandboxType": "basic",
"sandboxVersion": "v1",
"error": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"status": 400,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>"
}
]
}{
"error": "<string>",
"status": 403,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": "<string>",
"status": 409,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": "<string>",
"status": 410,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": "<string>",
"status": 500,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}