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.

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

organizationId
string<uuid>
obrigatório

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

Corpo

application/json
uploadId
string<uuid>
obrigatório

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>
obrigatório
Opções disponíveis:
python3.11,
native
arguments
object[]
obrigatório
returnType
string
obrigatório
type
string
obrigatório
Allowed value: "executable"
functionName
string
obrigatório
Pattern: ^[A-Za-z][A-Za-z0-9_]*$
returnName
string | null
Pattern: ^[A-Za-z][A-Za-z0-9_]*$
commandReadTimeout
integer
padrão:10000
commandWriteTimeout
integer
padrão:10000
memoryLimitMib
integer | null
Intervalo obrigatório: 1 <= x <= 1048576
sendChunkHeader
boolean
padrão:false
deterministic
boolean
padrão: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
padrão:TabSeparated
sandboxType
enum<string>
padrão:basic
Opções disponíveis:
basic,
netenable
sandboxVersion
enum<string>
padrão:v2
Opções disponíveis:
v1,
v2,
v3
poolSize
null

Always null — an executable UDF has no command pool.

maxCommandExecutionTime
integer | null
padrão:10
Intervalo obrigatório: x > 0

Resposta

UDF created and building.

status
integer
obrigatório

HTTP status code.

Exemplo:

201

requestId
string<uuid>
obrigatório

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
obrigatório
Última modificação em 3 de outubro de 2026