Create UDF upload URL | ClickHouse Docs

POST/v1/organizations/{organizationId}/udfUploads/url

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

Creates an org-scoped presigned application/zip upload URL. Callers must use an upload ID for only one create or version attempt and request a new upload URL when retrying.

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

Response

JSON

201

Upload URL created.

JSON

statusintegerrequired
HTTP status code.

Example: 201
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
3 properties
- uploadIdstringrequired
  Identifier of the uploaded source archive.
  
  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)$
- uploadUrlstringrequired
  Presigned URL for uploading the source archive.
  
  format: uri
- expiresAtstringrequired
  Presigned-URL expiry timestamp.
  
  format: date-time

Create UDF upload URL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/udfUploads/url \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/udfUploads/url';
const options = {method: 'POST', headers: {Authorization: 'Basic <token>'}};

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/udfUploads/url"

headers = {"Authorization": "Basic <token>"}

response = requests.post(url, headers=headers)

print(response.text)

Response example

{
  "status": 201,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "uploadId": "ef523ba8-509e-47af-8e2c-5fa751596497",
    "uploadUrl": "http://example.com",
    "expiresAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "string",
  "issues": [
    {
      "path": [
        "string"
      ],
      "code": "string",
      "message": "string"
    }
  ],
  "status": 400,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

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