Attach UDF to service | ClickHouse Docs

PUT/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}

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

Attaches one UDF version to a service, replacing the current version when necessary. When version is omitted, the latest ready version is attached.

Authorizations

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

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_]*$
serviceIdstringrequired
ID of the requested 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)$

Request bodyJSON

versionoptionalinteger
Version to attach. When omitted, the latest ready version is attached.

Example: 1

Response

JSON

200

Current attachment state.

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

Attach UDF to service

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/udfs/string/attachments/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "version": 1
}'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/udfs/string/attachments/497f6eca-6276-4993-bfeb-53cbbbba6f08';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({version: 1})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/udfs/string/attachments/497f6eca-6276-4993-bfeb-53cbbbba6f08"

payload = { "version": 1 }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <token>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "functionName": "string",
    "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
    "status": "deployed",
    "version": 1
  }
}

{
  "error": "string",
  "status": 400,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "error": "string",
  "status": 404,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "error": "string",
  "status": 409,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "error": "string",
  "status": 422,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "error": "string",
  "code": "SERVICE_IDLE",
  "serviceState": "starting",
  "canWake": true,
  "status": 424,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "error": "string",
  "status": 500,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "property1": null,
  "property2": null
}