Skip to main content
POST
Create UDF version
Consumes a source archive, assigns a version, and starts the UDF build. Optional configuration fields omitted from the request use the defaults documented in the request schema; values are not inherited from the previous version. Retry by requesting a new upload URL and re-uploading.

Permission

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

Авторизации

Authorization
string
header
обязательно

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

Параметры пути

organizationId
string<uuid>
обязательно

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)$
functionName
string
обязательно

Name of the UDF.

Pattern: ^[A-Za-z][A-Za-z0-9_]*$

Тело

application/json
uploadId
string<uuid>
обязательно

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>
обязательно
Доступные опции:
python3.11,
native
arguments
object[]
обязательно
returnType
string
обязательно
type
string
обязательно
Allowed value: "executable"
returnName
string | null
Pattern: ^[A-Za-z][A-Za-z0-9_]*$
commandReadTimeout
integer
по умолчанию:10000
commandWriteTimeout
integer
по умолчанию:10000
memoryLimitMib
integer | null
Требуемый диапазон: 1 <= x <= 1048576
sendChunkHeader
boolean
по умолчанию:false
deterministic
boolean
по умолчанию: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
по умолчанию:TabSeparated
sandboxType
enum<string>
по умолчанию:basic
Доступные опции:
basic,
netenable
sandboxVersion
enum<string>
по умолчанию:v2
Доступные опции:
v1,
v2,
v3
poolSize
null

Always null — an executable UDF has no command pool.

maxCommandExecutionTime
integer | null
по умолчанию:10
Требуемый диапазон: x > 0

Ответ

UDF version created and building.

status
integer
обязательно

HTTP status code.

Пример:

201

requestId
string<uuid>
обязательно

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
обязательно
Последнее изменение 3 октября 2026 г.