Attach UDF to service

PUT

organizations

{organizationId}

udfs

{functionName}

attachments

{serviceId}

Attach UDF to service

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "version": 1
}'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}"

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({version: 1})
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'version' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}"

	payload := strings.NewReader("{\n  \"version\": 1\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"version\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "functionName": "<string>",
    "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "deployed",
    "version": 1
  }
}

{
  "error": "<string>",
  "status": 400,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "status": 404,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "status": 409,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "status": 422,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "code": "SERVICE_IDLE",
  "serviceState": "starting",
  "canWake": true,
  "status": 424,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "status": 500,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

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_]*$

serviceId

string<uuid>

必須

ID of the requested service.

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

ボディ

application/json

version

integer

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

例:

1

レスポンス

Current attachment state.

status

integer

必須

HTTP status code.

例:

200

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

必須

Show child attributes

最終更新日 2026年10月3日

Attach UDF to service

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "version": 1
}'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}"

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({version: 1})
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'version' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}"

	payload := strings.NewReader("{\n  \"version\": 1\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"version\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "functionName": "<string>",
    "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "deployed",
    "version": 1
  }
}

{
  "error": "<string>",
  "status": 400,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "status": 404,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "status": 409,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "status": 422,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "code": "SERVICE_IDLE",
  "serviceState": "starting",
  "canWake": true,
  "status": 424,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": "<string>",
  "status": 500,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

はじめる

サービスとインフラストラクチャ

Bring Your Own Cloud

データとインテグレーション

接続とクエリ実行

アクセス管理

セキュリティとコンプライアンス

監視とバックアップ

AI ツールとエージェント

Cloud API

請求

サポート

Permission

承認

パスパラメータ

ボディ

レスポンス

​Permission

承認

パスパラメータ

ボディ

レスポンス

Permission