Skip to main content
POST
Create UDF
Creates a new UDF. See User-defined functions in Cloud.

Permission

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

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

organizationId
string<uuid>
requis

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)$

Corps

application/json
uploadId
string<uuid>
requis

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)$
runtime
enum<string>
requis
Options disponibles:
python3.11,
native
arguments
object[]
requis
returnType
string
requis
type
string
requis
Allowed value: "executable"
functionName
string
requis
Pattern: ^[A-Za-z][A-Za-z0-9_]*$
returnName
string | null
Pattern: ^[A-Za-z][A-Za-z0-9_]*$
commandReadTimeout
integer
défaut:10000
commandWriteTimeout
integer
défaut:10000
memoryLimitMib
integer | null
Plage requise: 1 <= x <= 1048576
sendChunkHeader
boolean
défaut:false
deterministic
boolean
défaut:false

Marks 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.

format
string
défaut:TabSeparated
sandboxType
enum<string>
défaut:basic
Options disponibles:
basic,
netenable
sandboxVersion
enum<string>
défaut:v2
Options disponibles:
v1,
v2,
v3
poolSize
null

Always null — an executable UDF has no command pool.

maxCommandExecutionTime
integer | null
défaut:10
Plage requise: x > 0

Réponse

UDF created and building.

status
integer
requis

HTTP status code.

Exemple:

201

requestId
string<uuid>
requis

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)$
result
object
requis
Dernière modification le 3 octobre 2026