Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

List UDFs

Beta
GET/v1/organizations/{organizationId}/udfs
API playground

Disclaimer: This beta endpoint is evolving; the API contract may change.

Returns the latest version of each UDF in the organization.

Permission

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

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the requested organization.

    format: uuid, 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)$

Query parameters

  • cursoroptionalstring

    Cursor returned in pagination.nextCursor from the previous page.

  • limitoptionalinteger

    Maximum number of records to return per page. Defaults to 100. Maximum is 100.

    maximum: 100
    Default: 100

Response

JSON

200

Successful response.

JSON
  • statusintegerrequired

    HTTP status code.

    Example: 200
  • requestIdstringrequired

    Unique id assigned to every request. UUIDv4

    format: uuid, 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)$
  • resultobjectrequired
    2 properties
    • itemsarray ofobjectrequired

      Latest version of each UDF in the organization.

      21 properties
      • functionNamestringrequired

        Name of the UDF. Unique within the organization.

      • versionintegerrequired

        Version number of the UDF.

        Example: 1
      • statusbuildingorerrororreadyrequired

        Build state of this UDF version.

      • runtimepython3.11ornativerequired

        Runtime used to execute the UDF command.

      • typeexecutableorexecutable_poolrequired

        Executable UDF type.

      • argumentsarray ofobjectrequired

        Arguments passed to the UDF command.

        2 properties
        • namestringrequired

          Name of the argument. Required for Native and JSONEachRow formats.

          pattern: ^[A-Za-z][A-Za-z0-9_]*$
        • typestringrequired

          ClickHouse data type of the argument.

      • returnTypestringrequired

        ClickHouse data type of the returned value.

      • returnNamestringornullrequired

        Name of the returned value, or null when unnamed.

        2 variants

        One of the following:

        • string
        • null
      • poolSizeintegerornullrequired

        Command pool size for executable_pool UDFs.

        2 variants

        One of the following:

        • integer
        • null
      • commandReadTimeoutintegerrequired

        Command stdout read timeout in milliseconds.

      • commandWriteTimeoutintegerrequired

        Command stdin write timeout in milliseconds.

      • maxCommandExecutionTimeintegerornullrequired

        Maximum command execution time in seconds for executable_pool UDFs.

        2 variants

        One of the following:

        • integer
        • null
      • memoryLimitMibintegerornullrequired

        Maximum memory, in MiB, available to each UDF sandbox process. Null uses the sandbox default.

        Default: null
        2 variants

        One of the following:

        • integer
        • null
      • sendChunkHeaderbooleanrequired

        Whether ClickHouse sends a row-count chunk header.

      • deterministicbooleanrequired

        Whether ClickHouse may reuse cached query results for this UDF.

      • formatstringrequired

        Input and output format used by the UDF command.

      • sandboxTypebasicornetenablerequired

        Sandbox isolation level.

      • sandboxVersionv1orv2orv3required

        Sandbox runtime version.

      • errorstringornullrequired

        Build error, or null when no build error is present.

        2 variants

        One of the following:

        • string
        • null
      • createdAtstringrequired

        Creation timestamp.

        format: date-time
      • updatedAtstringrequired

        Last-update timestamp.

        format: date-time
    • paginationobjectrequired
      4 properties
      • totalRecordsintegerrequired

        Total number of records available.

      • currentCursorstringornullrequired

        Cursor for the current page. Null for the first page.

        2 variants

        One of the following:

        • string
        • null
      • nextCursorstringornullrequired

        Cursor for the next page. Null if there are no more results.

        2 variants

        One of the following:

        • string
        • null
      • limitintegerrequired

        Maximum number of records returned per page.

Report an issue
Navigation