Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

List UDF attachments

Beta
View as MarkdownEdit this pageReport an issueSet up docs MCP
GET/v1/organizations/{organizationId}/udfs/{functionName}/attachments

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

Returns the current service attachments for a UDF, with at most one attachment per service.

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

    Name of the UDF.

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

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
      4 properties
      • functionNamestringrequired

        Name of the UDF.

      • serviceIdstringrequired

        ID of the attached service.

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

        Current attachment lifecycle state.

      • versionintegerrequired

        Attached UDF version.

        Example: 1
    • 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.

Navigation