ClickHouse Cloud: Clickhouse Upgrade Window Update

Set service upgrade window.

Tool ID: clickhouse_upgrade_window_update

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_upgrade_window_update',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000",
    "weekday": 6,
    "startHourUtc": 0
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_upgrade_window_update --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "weekday": 6,
  "startHourUtc": 0
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "weekday": 6,
      "startHourUtc": 0,
      "duration": 6
    }
  }
}

Use deepline tools get clickhouse_upgrade_window_update --json for the latest machine-readable contract.

Input reference

Creates or fully replaces the upgrade window for a service. The upgrade window currently lasts 6 hours from startHourUtc. The upgrade window can only be set on primary services; secondary services inherit the primary service window. Errors: - 400: invalid field values (weekday not in 0–6, startHourUtc not in {0, 6, 12, 18}), or the service is a secondary service. - 401: missing, invalid, or disabled API key. - 403: caller lacks control-plane:service:manage on the service, or the organization does not have the scheduled upgrades feature enabled. - 404: service does not exist or is not visible to the caller.

Name	Type	Required	Default	Details
`payload.organizationId`	`string`	Yes	—	ID of the organization that owns the service. Format: `uuid`.
`payload.serviceId`	`string`	Yes	—	ID of the service. Format: `uuid`.
`payload.weekday`	`integer`	Yes	—	Day of the week the upgrade window starts. 0 = Sunday, 1 = Monday, …, 6 = Saturday. Minimum: 0. Maximum: 6.
`payload.startHourUtc`	`0 \| 6 \| 12 \| 18`	Yes	—	UTC hour when the upgrade window starts. Must be one of 0, 6, 12, or 18. The upgrade window currently lasts 6 hours from this start time. Allowed: `0`, `6`, `12`, `18`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.status`	`number`	No	—	HTTP status code.
`result.data.requestId`	`string`	No	—	Unique id assigned to every request. UUIDv4 Format: `uuid`.
`result.data.result`	`object`	No	—	—
`result.data.result.weekday`	`integer`	Yes	—	Day of the week the upgrade window starts. 0 = Sunday, 1 = Monday, …, 6 = Saturday. Minimum: 0. Maximum: 6.
`result.data.result.startHourUtc`	`0 \| 6 \| 12 \| 18`	Yes	—	UTC hour when the upgrade window starts. Must be one of 0, 6, 12, or 18. Allowed: `0`, `6`, `12`, `18`.
`result.data.result.duration`	`6`	Yes	—	Length of the upgrade window in hours. Currently only a 6-hour window is supported. Allowed: `6`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

ClickHouse Cloud: Clickhouse Upgrade Window Update

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation